Adjust indent

Author: danielsaidi

Sources/RichTextKit/Colors/ColorRepresentable.swift

@@ -9,19 +9,13 @@
 #if macOS
 import AppKit
 
-/**
- This typealias bridges platform-specific colors to simplify
- multi-platform support.
- */
+/// This typealias bridges platform-specific colors.
 public typealias ColorRepresentable = NSColor
 #endif
 
 #if iOS || os(tvOS) || os(watchOS) || os(visionOS)
 import UIKit
 
-/**
- This typealias bridges platform-specific colors to simplify
- multi-platform support.
- */
+/// This typealias bridges platform-specific colors.
 public typealias ColorRepresentable = UIColor
 #endif

Sources/RichTextKit/Colors/RichTextColor+Picker.swift

@@ -10,26 +10,19 @@ import SwiftUI
 
 public extension RichTextColor {
 
-    /**
-     This picker can be used to select a rich text color.
-
-     This picker renders an icon next to the color picker as
-     well as an optional list of quick colors.
-
-     The quick color list is empty by default. You can add a
-     custom set of colors, for instance `.quickPickerColors`.
-     */
+    /// This picker can be used to select a rich text color.
+    ///
+    /// This picker renders an icon next to the color picker
+    /// as well as an optional list of custom quick colors.
     struct Picker: View {
 
-        /**
-         Create a rich text color picker that binds to a color.
-
-         - Parameters:
-          - type: The type of color to pick.
-          - icon: The icon to show, if any, by default the `type` icon.
-          - value: The value to bind to.
-          - quickColors: Colors to show in the trailing list, by default no colors.
-         */
+        /// Create a rich text color picker.
+        ///
+        /// - Parameters:
+        ///   - type: The type of color to pick.
+        ///   - icon: The icon to show, if any, by default the `type` icon.
+        ///   - value: The value to bind to.
+        ///   - quickColors: Colors to show in the trailing list, by default no colors.
         public init(
             type: RichTextColor,
             icon: Image? = nil,

Sources/RichTextKit/Colors/RichTextColor.swift

@@ -8,11 +8,7 @@
 
 import SwiftUI
 
-/**
- This enum defines supported rich text color types.
-
- The enum makes the colors identifiable and diffable.
- */
+/// This enum defines supported rich text color types.
 public enum RichTextColor: String, CaseIterable, Codable, Equatable, Identifiable {
 
     /// Foreground color.

Sources/RichTextKit/Commands/RichTextCommand+ActionButton.swift

@@ -10,21 +10,17 @@ import SwiftUI
 
 public extension RichTextCommand {
 
-    /**
-     This button can trigger any ``RichTextAction`` from the
-     main menu.
-
-     This view requires that a ``RichTextContext`` is set as
-     a focused value, otherwise it will be disabled.
-     */
+    /// This button can trigger ``RichTextAction``s from the
+    /// main menu.
+    ///
+    /// This view requires that a ``RichTextContext`` is set
+    /// as a focused value, otherwise it will be disabled.
     struct ActionButton: View {
 
-        /**
-         Create a command button.
-
-         - Parameters:
-         - action: The action to trigger.
-         */
+        /// Create a command button.
+        ///
+        /// - Parameters:
+        ///   - action: The action to trigger.
         public init(
             action: RichTextAction
         ) {

Sources/RichTextKit/Commands/RichTextCommand+ActionButtonGroup.swift

@@ -10,13 +10,11 @@ import SwiftUI
 
 public extension RichTextCommand {
 
-    /**
-     This view can add list of ``RichTextAction`` buttons to
-     the main menu.
-
-     This view requires that a ``RichTextContext`` is set as
-     a focused value, otherwise it will be disabled.
-     */
+    /// This view can add list of ``RichTextAction`` buttons
+    /// to the main menu.
+    ///
+    /// This view requires that a ``RichTextContext`` is set
+    /// as a focused value, otherwise it will be disabled. 
     struct ActionButtonGroup: View {
 
         /**

Sources/RichTextKit/Commands/RichTextCommand+FormatMenu.swift

@@ -11,16 +11,13 @@ import SwiftUI
 
 public extension RichTextCommand {
 
-    /**
-     This menu adds standard rich text format options to the
-     main menu, using `CommandGroup`.
-
-     You can apply this to a `WindowGroup` or `DocumentGroup`
-     to make it appear in the app's main menu.
-
-     This menu requires that a ``RichTextContext`` is set as
-     a focused value, otherwise it will be disabled.
-     */
+    /// This menu adds format options to the main menu.
+    ///
+    /// You can add it to a `WindowGroup` or `DocumentGroup`,
+    /// to make it appear in the app's main menu.
+    ///
+    /// This view requires that a ``RichTextContext`` is set
+    /// as a focused value, otherwise it will be disabled.
     struct FormatMenu: Commands {
 
         /// Create a rich text format command menu.

Sources/RichTextKit/Commands/RichTextCommand+ShareMenu.swift

@@ -11,32 +11,26 @@ import SwiftUI
 
 public extension RichTextCommand {
 
-    /**
-     This menu view can add a list of sharing options to the
-     main menu.
-
-     The menu will try to add options for share, export, and
-     print, if applicable to the current platform. Selecting
-     an option will trigger a corresponding, provided action.
-
-     The macOS exclusive `nsSharing` commands require you to
-     return a share url, after which a command takes care of
-     the sharing. Also note that the `formatNSSharingAction`
-     and `pdfNSSharingAction` will only have effect on macOS,
-     where they add ``RichTextNSSharingMenu`` options.
-
-     Note that a pdf action menu will only be included if it
-     has a corresponding action. Also note that you must use
-     `isEnabled: false` to disable the menu, since you can't
-     add `.disabled` to the command menu.
-
-     Setting actions to `nil` removes the related menu items.
-     */
+    /// This menu adds share options to the main menu.
+    ///
+    /// This menu will attempt to add menu options for share,
+    /// export, and print, if applicable to the platform.
+    ///
+    /// The macOS exclusive `nsSharing` commands require you
+    /// to return a share url, after which the command takes
+    /// care of the sharing. The `formatNSSharingAction` and
+    /// `pdfNSSharingAction` only works on macOS, where they
+    /// add ``RichTextNSSharingMenu`` options.
+    ///
+    /// Note that a pdf action menu will only be included if
+    /// it has an action. You must use `isEnabled: false` to
+    /// disable the menu, since you can't add `.disabled` to
+    /// the command menu.
+    ///
+    /// Setting an action to `nil` removes the related menu.
     struct ShareMenu: Commands {
 
-        /**
-         Create a rich text share command menu.
-         */
+        /// Create a rich text share command menu.
         public init(
             isEnabled: Bool = true,
             shareFormats: [RichTextDataFormat],

Sources/RichTextKit/Commands/RichTextCommand.swift

@@ -8,11 +8,9 @@
 
 import Foundation
 
-/**
- This type is used as a namespace for command-specific types,
- like command menus and buttons.
-
- > Important: Most rich text commands require that there's a
- ``RichTextContext`` set as a focused value.
- */
+/// This is a namespace for command-specific types like menu
+/// and buttons commands.
+///
+/// > Important: The rich text-related commands require that
+/// there's a ``RichTextContext`` set as a focused value.
 public struct RichTextCommand {}

Sources/RichTextKit/Data/NSAttributedString+Init.swift

@@ -10,13 +10,11 @@ import Foundation
 
 public extension NSAttributedString {
 
-    /**
-     Try to parse ``RichTextDataFormat`` formatted data.
-
-     - Parameters:
-       - data: The data to initialize the string with.
-       - format: The data format to use.
-     */
+    /// Try to parse ``RichTextDataFormat`` formatted data.
+    ///
+    /// - Parameters:
+    ///   - data: The data to initialize the string with.
+    ///   - format: The data format to use.
     convenience init(
         data: Data,
         format: RichTextDataFormat

Sources/RichTextKit/Data/RichTextDataError.swift

@@ -8,9 +8,7 @@
 
 import Foundation
 
-/**
- This enum represents rich text data-related errors.
- */
+/// This enum represents rich text data-related errors.
 public enum RichTextDataError: Error {
 
     case invalidArchivedData(in: Data)

Sources/RichTextKit/Data/RichTextDataFormat+Menu.swift

@@ -11,15 +11,13 @@ import SwiftUI
 
 public extension RichTextDataFormat {
 
-    /**
-     This menu can be used to trigger custom actions for any
-     list of ``RichTextDataFormat`` values.
-
-     The menu uses customizable actions, which means that it
-     can be used in toolbars, menu bar commands etc. It also
-     has an optional `pdf` action, which for instance can be
-     used when exporting or sharing rich text.
-     */
+    /// This menu can be used to trigger a custom action for
+    /// any list of ``RichTextDataFormat`` values.
+    ///
+    /// The menu uses customizable actions, which means that
+    /// it can be used in toolbars, menubar commands etc. It
+    /// also has an optional `pdf` action, which can be used
+    /// when exporting or sharing rich text.
     struct Menu: View {
 
         public init(

Sources/RichTextKit/Data/RichTextDataFormat.swift

@@ -9,25 +9,22 @@
 import Foundation
 import UniformTypeIdentifiers
 
-/**
- This enum specifies rich text data formats.
-
- Different formats have different capabilities. For instance,
- ``rtf`` supports rich text, styles, etc., while ``plainText``
- only handles text. ``archivedData`` can archive text, image
- data and attachments in binary archives. This is convenient
- when only targeting Apple platforms, but restricts how data
- can be used elsewhere.
-
- ``archivedData`` uses an `rtk` file extension, as well as a
- `UTType.archivedData` uniform type. You can create a custom
- ``vendorArchivedData(id:fileExtension:fileFormatText:uniformType:)``
- value to specify a custom data format.
-
- Remember to configure your app for handling the UTTypes you
- want to support, as well as the file extensions you want to
- open with the app. Take a look at the demo app for examples.
- */
+/// This enum specifies rich text data formats.
+///
+/// For instance, ``rtf`` supports styles, colors etc. while
+/// ``plainText`` only handles text. ``archivedData`` can be
+/// used to archive texts, images and various attachments in
+/// binary archives. This is convenient when targeting Apple
+/// platforms, but restricts how data can be used elsewhere.
+///
+/// ``archivedData`` uses an `rtk` file extension as well as
+/// a `UTType.archivedData` uniform type. You can define any
+/// custom ``vendorArchivedData(id:fileExtension:fileFormatText:uniformType:)``
+/// value to specify a custom data format.
+///
+/// Remember to configure your app to handle the UTTypes you
+/// want to support, as well as the file extensions you want
+/// to open with it. Check out the demo app for examples.
 public enum RichTextDataFormat: Equatable, Identifiable {
 
     /// Archived data that's persisted with a keyed archiver.

Sources/RichTextKit/Data/RichTextDataReader.swift

@@ -8,25 +8,21 @@
 
 import Foundation
 
-/**
- This protocol extends ``RichTextReader`` with functionality
- for reading rich text data for the current rich text.
-
- The protocol is implemented by `NSAttributedString` as well
- as other types in the library.
- */
+/// This protocol extends the ``RichTextReader`` protocol to
+/// support reading rich text data for the current rich text.
+///
+/// This protocol is implemented by `NSAttributedString` and
+/// other types in the library.
 public protocol RichTextDataReader: RichTextReader {}
 
 extension NSAttributedString: RichTextDataReader {}
 
 public extension RichTextDataReader {
 
-    /**
-     Generate rich text data from the current rich text.
-
-     - Parameters:
-       - format: The data format to use.
-     */
+    /// Generate rich text data from the current rich text.
+    ///
+    /// - Parameters:
+    ///   - format: The data format to use.
     func richTextData(
         for format: RichTextDataFormat
     ) throws -> Data {

Sources/RichTextKit/Export/RichTextExportError.swift

@@ -8,10 +8,8 @@
 
 import Foundation
 
-/**
- This enum defines errors that can be thrown when failing to
- export rich text.
- */
+/// This enum defines errors that can be thrown when failing
+/// to export rich text.
 public enum RichTextExportError: Error {
 
     /// This error occurs when no file could be generated at a certain url.

Sources/RichTextKit/Export/RichTextExportMenu.swift

@@ -9,13 +9,8 @@
 #if iOS || macOS || os(visionOS)
 import SwiftUI
 
-/**
- This menu can be used to trigger various export actions for
- a list of ``RichTextDataFormat`` values.
-
- This menu uses a ``RichTextDataFormat/Menu`` configured for
- exporting, with customizable actions and data formats.
- */
+/// This menu can be used to call various export actions for
+/// a list of ``RichTextDataFormat`` values.
 public struct RichTextExportMenu: View {
 
     public init(