Docs, Naming

Author: thecoolwinter

Sources/CodeEditTextView/EmphasisManager/Emphasis.swift

@@ -9,23 +9,39 @@ import AppKit
 
 /// Represents a single emphasis with its properties
 public struct Emphasis {
+    /// The range the emphasis applies it's style to, relative to the entire text document.
     public let range: NSRange
+
+    /// The style to apply emphasis with, handled by the ``EmphasisManager``.
     public let style: EmphasisStyle
+
+    /// Set to `true` to 'flash' the emphasis before removing it automatically after being added.
+    ///
+    /// Useful when an emphasis should be temporary and quick, like when emphasizing paired brackets in a document.
     public let flash: Bool
+
+    /// Set to `true` to style the emphasis as 'inactive'.
+    ///
+    /// When ``style`` is ``EmphasisStyle/standard``, this reduces shadows and background color.
+    /// For all styles, if drawing text on top of them, this uses ``EmphasisManager/getInactiveTextColor`` instead of
+    /// the text view's text color to render the emphasized text.
     public let inactive: Bool
-    public let select: Bool
+
+    /// Set to `true` if the emphasis manager should update the text view's selected range to match
+    /// this object's ``Emphasis/range`` value.
+    public let selectInDocument: Bool
 
     public init(
         range: NSRange,
         style: EmphasisStyle = .standard,
         flash: Bool = false,
         inactive: Bool = false,
-        select: Bool = false
+        selectInDocument: Bool = false
     ) {
         self.range = range
         self.style = style
         self.flash = flash
         self.inactive = inactive
-        self.select = select
+        self.selectInDocument = selectInDocument
     }
 }

Sources/CodeEditTextView/EmphasisManager/EmphasisManager.swift

@@ -299,7 +299,7 @@ public final class EmphasisManager {
 
     /// Handles selection of text ranges for emphases where select is true
     private func handleSelections(for emphases: [Emphasis]) {
-        let selectableRanges = emphases.filter(\.select).map(\.range)
+        let selectableRanges = emphases.filter(\.selectInDocument).map(\.range)
         guard let textView, !selectableRanges.isEmpty else { return }
 
         textView.selectionManager.setSelectedRanges(selectableRanges)