Library Moduleswift-ucf 0.2.0proposals

    proposals

    The unified codelink format (UCF) is a set of extensions to the DocC symbol link format. It is intended to allow developers to incrementally adopt advanced features while reducing the amount of reformatting needed to upgrade existing documentation.

    README.md
    import proposals

    Module information

    Declarations
    17
    Symbols
    18

    Coverage

    100.0 percent of the declarations in proposals are completely undocumented

    Declarations

    23.5 percent of the declarations in proposals are operators29.4 percent of the declarations in proposals are initializers, type members, or enum cases11.8 percent of the declarations in proposals are instance members11.8 percent of the declarations in proposals are instance subscripts17.6 percent of the declarations in proposals are structures5.9 percent of the declarations in proposals are classes

    Interfaces

    100.0 percent of the declarations in proposals are unrestricted
    Module stats and coverage details

    This module defines the example symbols used in the various proposals and articles. It does not contain the UCF implementation, which lives in the swift-unidoc repository.

    Proposals

    Further reading

    • Unified codelink format motivation

      This document describes the motivation for the unified codelink format and gives a historical overview of several preexisting codelink formats. It is written as a separate document to avoid cluttering the UCF proposals and specifications with repetitive exposition.

      Read More