Skip to content

Commit 5136f8e

Browse files
Add EmphasisManager Docs
1 parent 1495df7 commit 5136f8e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Sources/CodeEditTextView/EmphasisManager/EmphasisManager.swift

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@
88
import AppKit
99

1010
/// Manages text emphases within a text view, supporting multiple styles and groups.
11+
///
12+
/// Text emphasis draws attention to a range of text, indicating importance.
13+
/// This object may be used in a code editor to emphasize search results, or indicate
14+
/// bracket pairs, for instance.
15+
///
16+
/// This object is designed to allow for easy grouping of emphasis types. An outside
17+
/// object is responsible for managing what emphases are visible. Because it's very
18+
/// likely that more than one type of emphasis may occur on the document at the same
19+
/// time, grouping allows each emphasis to be managed separately from the others by
20+
/// each outside object without knowledge of the other's state.
1121
public final class EmphasisManager {
1222
/// Internal representation of a emphasis layer with its associated text layer
1323
private struct EmphasisLayer {

0 commit comments

Comments
 (0)