diff --git a/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md b/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md index efa408fce..6a5fd3747 100644 --- a/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md +++ b/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md @@ -34,15 +34,12 @@ Licensed under the [MIT license](https://github.com/CodeEditApp/CodeEdit/blob/ma ### Text View -<<<<<<< chore/docs -- The SwiftUI API for the source editor. -======= -- ``SourceEditor`` The SwiftUI API for the source editor. ->>>>>>> main -- ``SourceEditorConfiguration`` Customize the source editor's behavior, layout, appearance, and more. -- ``SourceEditorState`` Listen to the current state of the editor. Cursor positions, scroll positions, and more. -- ``TextViewController`` The AppKit view controller for the source editor. -- ``GutterView`` A view used to display line numbers and folding regions. +- +- ``SourceEditor`` +- ``SourceEditorConfiguration`` +- ``SourceEditorState`` +- ``TextViewController`` +- ``GutterView`` ### Themes diff --git a/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md b/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditorView.md similarity index 98% rename from Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md rename to Sources/CodeEditSourceEditor/Documentation.docc/SourceEditorView.md index 9e53c2362..9326844ba 100644 --- a/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md +++ b/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditorView.md @@ -1,4 +1,4 @@ -# Source Editor +# Source Editor View ## Usage @@ -90,3 +90,6 @@ let editorController = TextViewController( ) ``` +## Topics + +- ``SourceEditor`` diff --git a/Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift b/Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift index c06ac526c..ad8c9eff9 100644 --- a/Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift +++ b/Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift @@ -31,11 +31,11 @@ import AppKit /// - The category initializer. /// - The passthrough variable in `TextViewController`. -/// Configuration object for the . Determines appearance, behavior, layout and what features are +/// Configuration object for the . Determines appearance, behavior, layout and what features are /// enabled (peripherals). /// /// To update the configuration, update the ``TextViewController/configuration`` property, or pass a value to the -/// SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will +/// SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will /// update the text controller as necessary for the new configuration. public struct SourceEditorConfiguration: Equatable { /// Configure the appearance of the editor. Font, theme, line height, etc. diff --git a/Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift b/Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift index 9629688aa..97d2a14f3 100644 --- a/Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift +++ b/Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift @@ -7,7 +7,7 @@ import AppKit -/// A protocol that can be used to receive extra state change messages from . +/// A protocol that can be used to receive extra state change messages from . /// /// These are used as a way to push messages up from underlying components into SwiftUI land without requiring passing /// callbacks for each message to the