Update documentation

Author: danielsaidi

Sources/RichTextKit/Attributes/RichTextAttribute.swift

@@ -8,13 +8,9 @@
 
 import Foundation
 
-/**
- This typealias represents a rich text dictionary key.
- */
+/// This typealias represents a rich text dictionary key.
 public typealias RichTextAttribute = NSAttributedString.Key
 
-/**
- This typealias represents a ``RichTextAttribute`` keyed and
- `Any` valued dictionary.
- */
+/// This typealias represents a dictionary with an attribute
+/// as key and `Any` as value.
 public typealias RichTextAttributes = [RichTextAttribute: Any]

Sources/RichTextKit/Attributes/RichTextAttributeReader.swift

@@ -8,19 +8,18 @@
 
 import Foundation
 
-/**
- This protocol extends ``RichTextReader`` with functionality
- for reading attributes from the ``RichTextReader/richText``.
-
- The protocol is implemented by `NSAttributedString` as well
- as other types in the library.
-
- Note that this protocol used to have a lot of functionality
- for getting various attributes, styles, etc. However, since
- ``RichTextViewComponent`` needs more capabilities, we ended
- up with duplicated code where the reader had functions that
- weren't even used within the library.
- */
+/// This protocol extends the ``RichTextReader`` protocol to
+/// make any implementing type able to get attributes in the
+/// ``RichTextReader/richText`` property.
+///
+/// This protocol is implemented by `NSAttributedString` and
+/// other types in the library.
+///
+/// > Note: The protocol used to have a lot of functionality
+/// for getting various attributes, styles, etc. However, it
+/// caused duplicated code since the ``RichTextViewComponent``
+/// needed more capabilities as well. As such, this protocol
+/// is now limited in functionality.
 public protocol RichTextAttributeReader: RichTextReader {}
 
 extension NSAttributedString: RichTextAttributeReader {}

Sources/RichTextKit/Attributes/RichTextAttributeWriter.swift

@@ -8,19 +8,18 @@
 
 import Foundation
 
-/**
- This protocol extends ``RichTextWriter`` with functionality
- for writing attributes to the ``RichTextWriter/richText`.
-
- This protocol is implemented by `NSMutableAttributedString`,
- as well as other types in the library.
-
- Note that this protocol used to have a lot of functionality
- for setting various attributes, styles, etc. However, since
- ``RichTextViewComponent`` needs more capabilities, we ended
- up with duplicated code where the writer had functions that
- weren't even used within the library.
- */
+/// This protocol extends the ``RichTextWriter`` protocol to
+/// make any implementing type able to set attributes in the
+/// ``RichTextReader/richText`` property.
+///
+/// This protocol is implemented by `NSAttributedString` and
+/// other types in the library.
+///
+/// > Note: The protocol used to have a lot of functionality
+/// for getting various attributes, styles, etc. However, it
+/// caused duplicated code since the ``RichTextViewComponent``
+/// needed more capabilities as well. As such, this protocol
+/// is now limited in functionality.
 public protocol RichTextAttributeWriter: RichTextWriter, RichTextAttributeReader {}
 
 extension NSMutableAttributedString: RichTextAttributeWriter {}

Sources/RichTextKit/Bridging/RichTextView_AppKit.swift

@@ -9,20 +9,16 @@
 #if macOS
 import AppKit
 
-/**
- This is a platform-agnostic rich text view that can be used
- in both UIKit and AppKit.
-
- The view inherits `NSTextView` in AppKit and `UITextView`
- in UIKit. It aims to make these views behave more alike and
- make them implement ``RichTextViewComponent``, which is the
- protocol that is used within this library.
-
- The view will apply a ``RichTextImageConfiguration/disabled``
- image config by default. You can change this by setting the
- property manually or by using a ``RichTextDataFormat`` that
- supports images.
- */
+/// This is a platform-agnostic text view for both UIKit and
+/// AppKit that makes the underlying views behave more alike.
+///
+/// The view inherits `NSTextView` in AppKit and `UITextView`
+/// in UIKit and implements ``RichTextViewComponent``, which
+/// is the protocol that is used within this library.
+///
+/// The view will apply a disabled ``imageConfiguration`` by
+/// default. You can change this by setting the property, or
+/// by applying a ``RichTextDataFormat`` that handles images.
 open class RichTextView: NSTextView, RichTextViewComponent {
 
     // MARK: - Properties

Sources/RichTextKit/Bridging/RichTextView_UIKit.swift

@@ -15,15 +15,16 @@ import UniformTypeIdentifiers
 extension RichTextView: UIDropInteractionDelegate {}
 #endif
 
-/**
- This is a platform-agnostic rich text view that can be used
- in both UIKit and AppKit.
-
- The view inherits `NSTextView` in AppKit and `UITextView`
- in UIKit. It aims to make these views behave more alike and
- make them implement ``RichTextViewComponent``, which is the
- protocol that is used within this library.
- */
+/// This is a platform-agnostic text view for both UIKit and
+/// AppKit that makes the underlying views behave more alike.
+///
+/// The view inherits `NSTextView` in AppKit and `UITextView`
+/// in UIKit and implements ``RichTextViewComponent``, which
+/// is the protocol that is used within this library.
+///
+/// The view will apply a disabled ``imageConfiguration`` by
+/// default. You can change this by setting the property, or
+/// by applying a ``RichTextDataFormat`` that handles images.
 open class RichTextView: UITextView, RichTextViewComponent {
 
     // MARK: - Initializers