Skip to content

Commit 82f9258

Browse files
authored
parameter updates in documentation (#206)
- resolved warnings generated by latest DocC compilation that highlighted missing, renamed, or misnamed parameters within the documentation.
1 parent 93e7a79 commit 82f9258

File tree

4 files changed

+9
-8
lines changed

4 files changed

+9
-8
lines changed

Sources/Markdown/Block Nodes/Tables/Table.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public extension Table {
5252
///
5353
/// - parameter columnAlignments: An optional list of alignments for each column,
5454
/// truncated or expanded with `nil` to fit the table's maximum column count.
55-
/// - parameter head: A ``Table/Head-swift.struct`` element serving as the table's head.
55+
/// - parameter header: A ``Table/Head-swift.struct`` element serving as the table's head.
5656
/// - parameter body: A ``Table/Body-swift.struct`` element serving as the table's body.
5757
init(columnAlignments: [ColumnAlignment?]? = nil,
5858
header: Head = Head(),

Sources/Markdown/Markdown.docc/Markdown/DoxygenCommands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Doxygen commands are not parsed within code blocks or block directive content.
4646

4747
- ``DoxygenDiscussion``
4848
- ``DoxygenNote``
49-
- ``DoxygenParam``
49+
- ``DoxygenParameter``
5050
- ``DoxygenReturns``
5151

5252
<!-- Copyright (c) 2023 Apple Inc and the Swift Project authors. All Rights Reserved. -->

Sources/Markdown/Visitor/MarkupVisitor.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ public protocol MarkupVisitor<Result> {
270270
/**
271271
Visit an `InlineAttributes` element and return the result.
272272

273-
- parameter attribute: An `InlineAttributes` element.
273+
- parameter attributes: An `InlineAttributes` element.
274274
- returns: The result of the visit.
275275
*/
276276
mutating func visitInlineAttributes(_ attributes: InlineAttributes) -> Result

Sources/Markdown/Walker/Walkers/MarkupFormatter.swift

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,9 @@ public struct MarkupFormatter: MarkupWalker {
267267
- emphasisMarker: The character to use for emphasis and strong emphasis markers.
268268
- condenseAutolinks: Print links whose link text and destination match as autolinks, e.g. `<https://swift.org>`.
269269
- preferredHeadingStyle: The preferred heading style.
270-
- lineLimit: The preferred maximum line length and method for splitting ``Text`` elements in an attempt to maintain that line length.
270+
- preferredLineLimit: The preferred maximum line length and method for splitting ``Text`` elements in an attempt to maintain that line length.
271271
- customLinePrefix: An addition prefix to print at the start of each line, useful for adding documentation comment markers.
272+
- doxygenCommandPrefix: The command command prefix, which defaults to ``DoxygenCommandPrefix/backslash``.
272273
*/
273274
public init(unorderedListMarker: UnorderedListMarker = .dash,
274275
orderedListNumerals: OrderedListNumerals = .allSame(1),
@@ -345,7 +346,7 @@ public struct MarkupFormatter: MarkupWalker {
345346
/// The length of the last line.
346347
var lastLineLength = 0
347348

348-
/// The line number of the most recently printed content.
349+
/// The line number of the most recently printed content.
349350
///
350351
/// This is updated in `addressPendingNewlines(for:)` when line breaks are printed.
351352
var lineNumber = 0
@@ -543,7 +544,7 @@ public struct MarkupFormatter: MarkupWalker {
543544
state.currentLength += prefix.count
544545
state.lastLineLength += prefix.count
545546
}
546-
547+
547548
result += rawText
548549
state.currentLength += rawText.count
549550
state.lastLineLength += rawText.count
@@ -734,7 +735,7 @@ public struct MarkupFormatter: MarkupWalker {
734735
}
735736
descendInto(listItem)
736737
}
737-
738+
738739
public mutating func visitHeading(_ heading: Heading) {
739740
if heading.indexInParent > 0 {
740741
ensurePrecedingNewlineCount(atLeast: 2)
@@ -1153,7 +1154,7 @@ public struct MarkupFormatter: MarkupWalker {
11531154
print(attributes.attributes, for: attributes)
11541155
print(")", for: attributes)
11551156
}
1156-
1157+
11571158
printInlineAttributes()
11581159

11591160
// Inline attributes *can* have their key-value pairs split across multiple

0 commit comments

Comments
 (0)