Skip to content

Commit a148366

Browse files
Clean Up Documentation Site (CodeEditApp#343)
Clean up documentation site, clean up all warnings.
1 parent 7e6d434 commit a148366

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

Sources/CodeEditSourceEditor/Documentation.docc/Documentation.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,12 @@ Licensed under the [MIT license](https://github.com/CodeEditApp/CodeEdit/blob/ma
3434

3535
### Text View
3636

37-
<<<<<<< chore/docs
38-
- <doc:SourceEditor> The SwiftUI API for the source editor.
39-
=======
40-
- ``SourceEditor`` The SwiftUI API for the source editor.
41-
>>>>>>> main
42-
- ``SourceEditorConfiguration`` Customize the source editor's behavior, layout, appearance, and more.
43-
- ``SourceEditorState`` Listen to the current state of the editor. Cursor positions, scroll positions, and more.
44-
- ``TextViewController`` The AppKit view controller for the source editor.
45-
- ``GutterView`` A view used to display line numbers and folding regions.
37+
- <doc:SourceEditorView>
38+
- ``SourceEditor``
39+
- ``SourceEditorConfiguration``
40+
- ``SourceEditorState``
41+
- ``TextViewController``
42+
- ``GutterView``
4643

4744
### Themes
4845

Sources/CodeEditSourceEditor/Documentation.docc/SourceEditor.md renamed to Sources/CodeEditSourceEditor/Documentation.docc/SourceEditorView.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Source Editor
1+
# Source Editor View
22

33
## Usage
44

@@ -90,3 +90,6 @@ let editorController = TextViewController(
9090
)
9191
```
9292

93+
## Topics
94+
95+
- ``SourceEditor``

Sources/CodeEditSourceEditor/SourceEditorConfiguration/SourceEditorConfiguration.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ import AppKit
3131
/// - The category initializer.
3232
/// - The passthrough variable in `TextViewController`.
3333

34-
/// Configuration object for the <doc:SourceEditor>. Determines appearance, behavior, layout and what features are
34+
/// Configuration object for the <doc:SourceEditorView>. Determines appearance, behavior, layout and what features are
3535
/// enabled (peripherals).
3636
///
3737
/// To update the configuration, update the ``TextViewController/configuration`` property, or pass a value to the
38-
/// <doc:SourceEditor> SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will
38+
/// <doc:SourceEditorView> SwiftUI API. Both methods will call the `didSetOnController` method on this type, which will
3939
/// update the text controller as necessary for the new configuration.
4040
public struct SourceEditorConfiguration: Equatable {
4141
/// Configure the appearance of the editor. Font, theme, line height, etc.

Sources/CodeEditSourceEditor/TextViewCoordinator/TextViewCoordinator.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import AppKit
99

10-
/// A protocol that can be used to receive extra state change messages from <doc:SourceEditor>.
10+
/// A protocol that can be used to receive extra state change messages from <doc:SourceEditorView>.
1111
///
1212
/// These are used as a way to push messages up from underlying components into SwiftUI land without requiring passing
1313
/// callbacks for each message to the

0 commit comments

Comments
 (0)