Skip to content
Prev Previous commit
Next Next commit
Fix documentation
  • Loading branch information
kimdv committed Dec 14, 2024
commit dba874b4af371ea1e9030bfd040d2854cb45e7a3
4 changes: 2 additions & 2 deletions Sources/SwiftFormat/API/SwiftFormatter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public final class SwiftFormatter {
/// This form of the `format` function automatically folds expressions using the default operator
/// set defined in Swift. If you need more control over this—for example, to provide the correct
/// precedence relationships for custom operators—you must parse and fold the syntax tree
/// manually and then call ``format(syntax:assumingFileURL:to:)``.
/// manually and then call ``format(syntax:source:operatorTable:assumingFileURL:selection:to:)``.
///
/// - Parameters:
/// - url: The URL of the file containing the code to format.
Expand Down Expand Up @@ -81,7 +81,7 @@ public final class SwiftFormatter {
/// This form of the `format` function automatically folds expressions using the default operator
/// set defined in Swift. If you need more control over this—for example, to provide the correct
/// precedence relationships for custom operators—you must parse and fold the syntax tree
/// manually and then call ``format(syntax:assumingFileURL:to:)``.
/// manually and then call ``format(syntax:source:operatorTable:assumingFileURL:selection:to:)``.
///
/// - Parameters:
/// - source: The Swift source code to be formatted.
Expand Down
5 changes: 3 additions & 2 deletions Sources/SwiftFormat/API/SwiftLinter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public final class SwiftLinter {
/// This form of the `lint` function automatically folds expressions using the default operator
/// set defined in Swift. If you need more control over this—for example, to provide the correct
/// precedence relationships for custom operators—you must parse and fold the syntax tree
/// manually and then call ``lint(syntax:assumingFileURL:)``.
/// manually and then call ``lint(syntax:source:operatorTable:assumingFileURL:)``.
///
/// - Parameters:
/// - url: The URL of the file containing the code to format.
Expand Down Expand Up @@ -76,7 +76,7 @@ public final class SwiftLinter {
/// This form of the `lint` function automatically folds expressions using the default operator
/// set defined in Swift. If you need more control over this—for example, to provide the correct
/// precedence relationships for custom operators—you must parse and fold the syntax tree
/// manually and then call ``lint(syntax:assumingFileURL:)``.
/// manually and then call ``lint(syntax:source:operatorTable:assumingFileURL:)``.
///
/// - Parameters:
/// - source: The Swift source code to be linted.
Expand Down Expand Up @@ -124,6 +124,7 @@ public final class SwiftLinter {
///
/// - Parameters:
/// - syntax: The Swift syntax tree to be converted to be linted.
/// - source: The Swift source code to be linted.
/// - operatorTable: The table that defines the operators and their precedence relationships.
/// This must be the same operator table that was used to fold the expressions in the `syntax`
/// argument.
Expand Down
Loading