Skip to content

Documentation #5

Closed
Closed
@1ec5

Description

@1ec5

The library should have a documentation comment for every public symbol. Swift uses reStructuredText format for documentation comments.

Additionally, we can look into generating HTML documentation based on these comments. The mobile team is quite happy with jazzy, which relies on the compiler for parsing, so you know it’ll work with whatever syntax you throw at it. It also generates a Dash docset for those who like their documentation that way.

/cc @bsudekum @friedbunny

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions