The compiler generates for every
Module.rsc a markdown file with the following structure:
// for each declaration (function, data, syntax, alias, import, extend)
So, for all standard Concept headers, like
Benefits there is a place at every declaration.
The content of the header paragraphs is either directly derived from source code (like function signature and data definitions), or it is taken from the following Tag definitions on each declaration:
@docmay contain literally the headers of a Concept, like
#### Synopsis. This notation is deprecated in favor of the tags below.
@synopsisis a single line description of the definition.
@descriptionis a multi-line explanantion of the definition.
@functioneach follow the intent of the standard Concept headers.
- A (small) part of documentation writing is automated. The information about the name of a function, data or annotation declaration, or its signature is always consistent.
- You can write examples of the usage of each definition using Listing markup that is run and checked at documentation compile-time.
- This approach requires that functions with the same name are grouped together in the source file.
- You need to run the tutor compiler before errors in the documentation tags are detected.