Update documentation comments.

Author: colinc86

Sources/LaTeXSwiftUI/Extensions/EnvironmentValues+Extensions.swift

@@ -104,21 +104,25 @@ extension EnvironmentValues {
     set { self[TeXInputProcessorOptionsKey.self] = newValue }
   }
 
+  /// The processEscapes value of this environment.
   var processEscapes: Bool {
     get { self[ProcessEscapesKey.self] }
     set { self[ProcessEscapesKey.self] = newValue }
   }
 
+  /// The equation number mode of this environment.
   var equationNumberMode: LaTeX.EquationNumberMode {
     get { self[EquationNumberModeKey.self] }
     set { self[EquationNumberModeKey.self] = newValue }
   }
 
+  /// The equation starting number of this environment.
   var equationNumberStart: Int {
     get { self[EquationNumberStartKey.self] }
     set { self[EquationNumberStartKey.self] = newValue }
   }
 
+  /// The equation number offset of this environment.
   var equationNumberOffset: CGFloat {
     get { self[EquationNumberOffsetKey.self] }
     set { self[EquationNumberOffsetKey.self] = newValue }

Sources/LaTeXSwiftUI/Extensions/View+Extensions.swift

@@ -80,24 +80,52 @@ public extension View {
   ///   render images in its view.
   @available(*, deprecated, message: """
 This method will be unavailable in the next version. Use the `processEscapes`,
-`equationTags`, `equationTagSide`, and `equationTagIndent` methods instead.
+`equationNumberMode`, `equationNumberStart`, and `equationNumberOffset` methods
+instead.
 """)
   func texOptions(_ options: TeXInputProcessorOptions) -> some View {
     environment(\.texOptions, options)
   }
 
+  /// When set to `true`, you may use `\$` to represent a literal dollar sign,
+  /// rather than using it as a math delimiter, and `\\` to represent a literal
+  /// backslash (so that you can use `\\\$` to get a literal `\$` or `\\$...$`
+  /// to get a backslash just before in-line math).
+  ///
+  /// When `false`, `\$` will not be altered, and its dollar sign may be
+  /// considered part of a math delimiter. Typically this is set to `true` if
+  /// you enable the `$ ... $` in-line delimiters, so you can type `\$` and
+  /// MathJax will convert it to a regular dollar sign in the rendered document.
+  ///
+  /// - Reference: [Option Descriptions](https://docs.mathjax.org/en/latest/options/input/tex.html#option-descriptions)
+  ///
+  /// - Parameter process: Whether escapes should be processed.
+  /// - Returns: A view that processes escapes in its text input.
   func processEscapes(_ process: Bool = true) -> some View {
     environment(\.processEscapes, process)
   }
 
+  /// Sets whether block view equation numbers should be hidden, displayed on
+  /// the left side of an equation, or displayed on the right side.
+  ///
+  /// - Parameter mode: The equation number mode.
+  /// - Returns: A view that numbers its equations.
   func equationNumberMode(_ mode: LaTeX.EquationNumberMode) -> some View {
     environment(\.equationNumberMode, mode)
   }
 
+  /// Sets the starting value for equation numbers in this view.
+  ///
+  /// - Parameter value: The starting value.
+  /// - Returns: A view that numbers its equations.
   func equationNumberStart(_ value: Int) -> some View {
     environment(\.equationNumberStart, value)
   }
 
+  /// Sets the number's left or right offset.
+  ///
+  /// - Parameter offset: The offset to set.
+  /// - Returns: A view that numbers its equations.
   func equationNumberOffset(_ offset: CGFloat) -> some View {
     environment(\.equationNumberOffset, offset)
   }

Sources/LaTeXSwiftUI/LaTeX.swift

@@ -28,6 +28,8 @@ import MathJaxSwift
 import Nuke
 import SwiftUI
 
+/// A view that can parse and render TeX and LaTeX equations that contain
+/// math-mode marcos.
 public struct LaTeX: View {
 
   // MARK: Types
@@ -109,9 +111,16 @@ public struct LaTeX: View {
   /// The TeX options to pass to MathJax.
   @Environment(\.texOptions) private var texOptions
 
+  /// Whether the view should process escapes.
   @Environment(\.processEscapes) private var processEscapes
+  
+  /// The view's equation number mode.
   @Environment(\.equationNumberMode) private var equationNumberMode
+  
+  /// The view's equation starting number.
   @Environment(\.equationNumberStart) private var equationNumberStart
+  
+  /// The view's equation number's offset.
   @Environment(\.equationNumberOffset) private var equationNumberOffset
 
   /// The view's current display scale.
@@ -408,24 +417,6 @@ struct LaTeX_Previews: PreviewProvider {
     }
     .fontDesign(.serif)
     .previewLayout(.sizeThatFits)
-    
-    VStack {
-      
-      // Don't number block equations (default)
-      LaTeX("$$a + b = c$$")
-        .equationNumberMode(.none)
-      
-      // Add left numbers and a leading offset
-      LaTeX("$$d + e = f$$")
-        .equationNumberMode(.left)
-        .equationNumberOffset(10)
-      
-      // Add right numbers, a leading offset, and start at 2
-      LaTeX("$$h + i = j$$ $$k + l = m$$")
-        .equationNumberMode(.right)
-        .equationNumberStart(2)
-        .equationNumberOffset(20)
-    }
   }
 
 }

Sources/LaTeXSwiftUI/Views/EquationNumber.swift

@@ -25,53 +25,71 @@
 
 import SwiftUI
 
+/// A view that draws a number next to an equation.
 struct EquationNumber: View {
 
+  // MARK: Types
+  
+  /// The side of the equation that the number appears on.
   enum EquationSide {
     case left
     case right
   }
 
+  // MARK: Public properties
+  
+  /// The index of the block attached to this number.
   let blockIndex: Int
+  
+  /// The side of the equation that this number appears on.
   let side: EquationSide
 
+  // MARK: Private properties
+  
+  /// The view's equation number mode.
   @Environment(\.equationNumberMode) private var equationNumberMode
+  
+  /// The view's equation starting number.
   @Environment(\.equationNumberStart) private var equationNumberStart
+  
+  /// The view's equation number's offset.
   @Environment(\.equationNumberOffset) private var equationNumberOffset
 
-    var body: some View {
-      switch equationNumberMode {
-      case .left:
-        if side == .left {
-          Text("(\(equationNumberStart + blockIndex))")
-            .padding([.leading], equationNumberOffset)
-        }
-        else {
-          Text("(\(equationNumberStart + blockIndex))")
-            .padding([.leading], equationNumberOffset)
-            .foregroundColor(.clear)
-        }
-        Spacer(minLength: 0)
-      case .right:
-        Spacer(minLength: 0)
-        if side == .right {
-          Text("(\(equationNumberStart + blockIndex))")
-            .padding([.trailing], equationNumberOffset)
-        }
-        else {
-          Text("(\(equationNumberStart + blockIndex))")
-            .padding([.trailing], equationNumberOffset)
-            .foregroundColor(.clear)
-        }
-      default:
-        EmptyView()
+  // MARK: View body
+  
+  var body: some View {
+    switch equationNumberMode {
+    case .left:
+      if side == .left {
+        Text("(\(equationNumberStart + blockIndex))")
+          .padding([.leading], equationNumberOffset)
       }
+      else {
+        Text("(\(equationNumberStart + blockIndex))")
+          .padding([.leading], equationNumberOffset)
+          .foregroundColor(.clear)
+      }
+      Spacer(minLength: 0)
+    case .right:
+      Spacer(minLength: 0)
+      if side == .right {
+        Text("(\(equationNumberStart + blockIndex))")
+          .padding([.trailing], equationNumberOffset)
+      }
+      else {
+        Text("(\(equationNumberStart + blockIndex))")
+          .padding([.trailing], equationNumberOffset)
+          .foregroundColor(.clear)
+      }
+    default:
+      EmptyView()
     }
+  }
 }
 
 struct EquationNumber_Previews: PreviewProvider {
-    static var previews: some View {
-      EquationNumber(blockIndex: 0, side: .left)
-        .environment(\.equationNumberMode, .left)
-    }
+  static var previews: some View {
+    EquationNumber(blockIndex: 0, side: .left)
+      .environment(\.equationNumberMode, .left)
+  }
 }