From 4d362952c08ec18e9c3ea94077313b66111a0b0c Mon Sep 17 00:00:00 2001 From: Khan Winter <35942988+thecoolwinter@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:31:51 -0500 Subject: [PATCH] Fix Broken Documentation Links --- .../Documentation.docc/Documentation.md | 7 ++++--- .../Documentation.docc/SourceEditor.md | 2 +- .../SourceEditorConfiguration.swift | 4 ++-- .../TextViewCoordinator/TextViewCoordinator.swift | 5 +++-- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md b/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md index dfc6a91b1..3d68eca83 100644 --- a/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md +++ b/Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md @@ -1,4 +1,4 @@ -# ``SourceEditor`` +# ``CodeEditSourceEditor`` A code editor with syntax highlighting powered by tree-sitter. @@ -34,8 +34,9 @@ Licensed under the [MIT license](https://github.com/CodeEditApp/CodeEdit/blob/ma ### Text View -- ``SourceEditor`` The SwiftUI API for the source editor. -- ``SourceEditorConfiguration`` Customize the source editor's behavior, layout, appearance, etc. +- The SwiftUI API for the source editor. +- ``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. 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