dev/docs/ref: Library Dependencies
$docs_note_types[]List of known documentation note types
$docs_last_lineStores the last generated line of documentation. Used internally to minimize spurious whitespace.
A note section begins with a line that starts with a known note keyword. The following pedantic example demonstrates a returns note section as it would appear the source code. As the name suggestions, this note section specifies a return value for a function:
# Returns: Success
This note section will be rendered as:
Returns: Success
Each type of note section may impose additional documentation syntax requirements or override the format for outputting the section contents.
See $docs_note_types[] for the list of built-in note types.
docs_note_keyword()Prints the canonical keyword of a note section on the current line ($1). If no known keyword is found, nothing is output.
is_docs_note()Returns success if line ($1) begins with a known note section keyword.
docs_gen_file_note()Begins a note section that starts on the given line ($1), formatting the output according the rules defined by the type of note section.
docs_gen_file_note_default()Prints a note section using a default format.
is_docs_section()Returns success if the given line ($1) is the start of a new section.
is_docs_symbol()Returns success if the given line ($1) is a documentated symbol.
is_docs_arg()Returns success if the given line ($1) is a documentated function argument.
docs_readline()Reads a line into the named var ($1)
$1 - Variable name to receive line of documentation
Returns: If a line could be read, returns success.
docs_lines_add()Caches lines ($@) of documentation for later generation.
docs_lines_cr()Caches a blank line of documentation.
docs_lines_here()Caches lines of documentation from standard input.
docs_lines_func()Caches lines of documentation generated from the given command ($@).
docs_gen_lines()Prints lines of documentation that have been cached via docs_lines_add() and friends. Sequences of multiple blank lines are reduced to a single line. This allows generation functions to be liberal when emitting whitespace between successive blocks of lines.
discard shebang line, read next