Skip to content

Commit e07a58a

Browse files
committed
validate and repair Unidoc’s own documentation
1 parent 92b3b4a commit e07a58a

35 files changed

+99
-110
lines changed

Sources/GitHubAPI/GitHub.OAuth.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ extension GitHub
66
///
77
/// > Note:
88
/// This type would be named `GitHub.OAuthApp`, but then ``GitHub.App`` would have to be
9-
/// named ``GitHub.AppApp``, and that would just be stupid.
9+
/// named `GitHub.AppApp`, and that would just be stupid.
1010
@frozen public
1111
struct OAuth:GitHubApplication
1212
{

Sources/HTTP/HTTP.Resource.Content.Body.swift

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ extension HTTP.Resource.Content.Body:CustomStringConvertible
3333
}
3434
extension HTTP.Resource.Content.Body
3535
{
36-
/// The size of the content to be transferred, in bytes. Unlike ``length``, this property
37-
/// is zero if the content is a ``length(_:)`` cache result.
36+
/// The size of the content to be transferred, in bytes.
3837
@inlinable public
3938
var size:Int
4039
{
@@ -45,16 +44,4 @@ extension HTTP.Resource.Content.Body
4544
case .string(let string): string.utf8.count
4645
}
4746
}
48-
/// The logical length of the content, in bytes, which may not reflect the actual ``size``
49-
/// of the data to be transferred.
50-
@inlinable public
51-
var length:Int
52-
{
53-
switch self
54-
{
55-
case .binary(let buffer): buffer.count
56-
case .buffer(let buffer): buffer.readableBytes
57-
case .string(let string): string.utf8.count
58-
}
59-
}
6047
}

Sources/HTTP/HTTP.Resource.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ extension HTTP.Resource:ExpressibleByStringLiteral, ExpressibleByStringInterpola
3737
extension HTTP.Resource
3838
{
3939
/// Computes and populates the resource ``hash`` if it has not already been computed, and
40-
/// drops the payload if it matches the given ``tag``.
40+
/// drops the payload if it matches the given `tag`.
4141
public mutating
4242
func optimize(tag:MD5?)
4343
{

Sources/HTTPServer/HTTP.ServerIntegralRequest.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ extension HTTP
2020
extension HTTP.ServerIntegralRequest
2121
{
2222
/// Inefficiently converts the headers to equivalent HPACK headers, and calls the witness
23-
/// for ``init?(get:headers:origin:)``.
23+
/// for ``init(get:headers:origin:) [37U4H]``.
2424
///
2525
/// Servers that expect to handle a lot of HTTP/1.1 GET requests should override this with
2626
/// a more efficient implementation.
@@ -33,7 +33,7 @@ extension HTTP.ServerIntegralRequest
3333
}
3434

3535
/// Inefficiently converts the headers to equivalent HPACK headers, and calls the witness
36-
/// for ``init?(post:headers:origin:body:)``.
36+
/// for ``init(post:headers:origin:body:) [XBU7]``.
3737
///
3838
/// Servers that expect to handle a lot of HTTP/1.1 POST requests should override this with
3939
/// a more efficient implementation.

Sources/IP/IP.V4.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extension IP
22
{
3-
/// A native SwiftNIO ``IPv4Address`` is reference counted and resilient, and we
3+
/// A native SwiftNIO `IPv4Address` is reference counted and resilient, and we
44
/// would rather pass around an inline value type.
55
@frozen public
66
struct V4:Equatable, Hashable, Sendable

Sources/IP/IP.V6.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
extension IP
22
{
3-
/// A native SwiftNIO ``IPv6Address`` is reference counted and resilient, and we
3+
/// A native SwiftNIO `IPv6Address` is reference counted and resilient, and we
44
/// would rather pass around an inline value type.
55
@frozen public
66
struct V6:Equatable, Hashable, Sendable

Sources/MarkdownABI/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Codewords and references can contain valid UTF-8 sequences. Therefore, they are
5757
- ``Markdown.CodeLanguageType``
5858
- ``Markdown.DiffType``
5959
- ``Markdown.PlainText``
60-
- ``Markdown.PlainText.Highligher``
60+
- ``Markdown.PlainText.Highlighter``

Sources/MarkdownAST/BlockElements/Markdown.BlockProse.swift

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ extension Markdown
2424
}
2525
}
2626

27-
/// Calls the superclass method, and then calls ``Markdown.TreeElement/outline(by:)``
28-
/// on each of the inline elements in this container.
27+
/// Calls the superclass method, and then calls
28+
/// ``Markdown.InlineElement/outline(by:) [6AL0]`` on each of the inline elements in
29+
/// this container.
2930
@inlinable public final override
3031
func outline(by register:(Markdown.AnyReference) throws -> Int?) rethrows
3132
{

Sources/MarkdownAST/Markdown.Source.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ extension Markdown
1515
{
1616
/// The absolute location of the markdown source within a larger source file,
1717
/// if known. If the markdown source was a standalone markdown file, this is
18-
/// ``SourceLocation/zero``.
18+
/// ``SourcePosition/zero``.
1919
public
2020
let origin:SourceLocation<Int32>?
2121
/// The unparsed markdown source text.

Sources/MarkdownAST/TableElements/Markdown.Table.AnyCell.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ extension Markdown.Table
1212
/// without any alignment attributes.
1313
///
1414
/// This method will never actually be called, because ``Markdown.Table`` bypasses it
15-
/// in favor of the ``emit(into:alignment:)`` method.
15+
/// in favor of the (internal) `emit(into:alignment:)` method.
1616
public final override
1717
func emit(into binary:inout Markdown.BinaryEncoder)
1818
{

0 commit comments

Comments
 (0)