Syntax

  • There are only two keywords for writing fundoc docstrings (for now):
    • @Article <Article name> for marking documentation sections to tell in which articale this section should be merged. You can use markdown syntax in documentation sections.
    • @Ignore for ignoring a marked documentation section.
    Example:
    /**
    @Article How it works
     *
    Title of the article
     *
    Some text
     */
    fn main() {}
    

[~]