Skip to content

Missing DocC documentation for @Reasync function #2

@broken-circle

Description

@broken-circle

If a function annotated with @Reasync has attached documentation, the documentation will appear in the macro expansion but not in the site built by DocC.

This is a compiler issue that affects all peer, member, preamble, and body macros.

Upstream issue: swiftlang/swift#88175
Pending fix: swiftlang/swift#88827

Workaround

Create a markdown file in the DocC archive for the generated peer overload, and DocC will correctly attach it to the symbol when building the site.

Reproduction

/// A function with documentation.
/// 
/// Documentation appears in the expansion, but not in the DocC site.
@Reasync
public func example() async
{
    let x = 1
    _ = x
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions