diff --git a/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md b/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md index 4384e4374..efa408fce 100644 --- a/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md +++ b/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md @@ -34,7 +34,11 @@ 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. diff --git a/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md b/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md index b3cec1725..9e53c2362 100644 --- a/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md +++ b/Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md @@ -1,4 +1,4 @@ -# ``SourceEditor`` +# Source Editor ## Usage diff --git a/Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift b/Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift index 7e3c725ae..c06ac526c 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 ``SourceEditor``. 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 -/// ``SourceEditor`` 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 ae7682500..9629688aa 100644 --- a/Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift +++ b/Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift @@ -7,10 +7,11 @@ import AppKit -/// A protocol that can be used to receive extra state change messages from ``SourceEditor``. +/// 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 ``SourceEditor`` initializer. +/// callbacks for each message to the +/// ``SourceEditor/init(_:language:configuration:state:highlightProviders:undoManager:coordinators:)`` initializer. /// /// They're very useful for updating UI that is directly related to the state of the editor, such as the current /// cursor position. For an example, see the ``CombineCoordinator`` class, which implements combine publishers for the