TOC stands for Table of Contents. It lists all documentation entries
Syntax: #?toc-entry <entryName>
Generates a TOC entry with provided name that links to HTML #<entryName> id
Example: #?toc-entry MyClass
Syntax: #?author <author>
Adds author description. Multiple authors allowed
Example: #?author Tapeline
Syntax: #?badge <badge-title> or #?badge-<badge-color> <badge-title>
Adds a badge with chosen color.
Available colors:
If color is not provided, it defaults.
Examples:
#?badge For testing purposes
#?badge-yellow Deprecated
Syntax: #?html <html>
Adds raw html
Example: #?html <h1>Overview</h1>
Syntax: #?since <since>
Add since badge. Only one per context allowed.
Example: #?since 0.1-alpha.2
Syntax #? <text>
Adds a textual description
Example: #? Checks if given key is present
Syntax: #?see <link>
Add a link. If link starts with > and special flag -sF.seeLinkPrefix is set, it will be prepended.
Also, if link starts with >, .q sequences will be dropped.
Examples:
#?see https://google.com#?see >event.q#EventManager::addHandlerClasses and functions are automatically documented.
Each class and function documentation entry is labeled with HTML id=.
Example:
class A {} # Will be id=#A
class B { # Will be id=#B
function c() {} # Will be id=#A::c
}
function d() {} # Will be id=#d
You can generate documentation using gendoc mode:
java -jar quail.jar gendoc fileToDocument.q > outputFile.html
Additional flags for mode available:
documentationHeadline Headline in TOC. Example:
java -jar quail.jar -sF.documentationHeadline="My Documentation" gendoc fileToDocument.q > outputFile.html