ArcShell

arcshell_doceng.sh

Reference

doceng_generate_page_modules_index

Builds the ‘modules_index.md’ file in the ‘docs’ folder.

> doceng_generate_page_modules_index

doceng_load_source_file_header

Builds a loadable file containing header variables and returns the string to load it.

> eval "$(doceng_load_source_file_header "source_file")"

doceng_return_examples

Returns the body of the special ‘EXAMPLE’ function if it exists.

> doceng_return_examples "file_path"

Runs the __links* function if it exists which returns a list of links.

> doceng_return_links "source_file"

doceng_delete_all

Deletes most of the files created by doceng.

> doceng_delete_all

doceng_get_synopsis

Returns the list of functions and the synopsis from a file. The automatically generated *_help functions call this.

> doceng_get_synopsis [ -a | -aa ] "file_path"
# -a: Include private functions.
# -aa: Return all documentation for the item.

doceng_get_documentation

Returns help for a file.

> doceng_get_documentation "file_path"

doceng_do_markdown

Generates the main .md file for a libary.

> doceng_do_markdown "file_path"

doceng_document_dir

Document the files in a directory.

> doceng_document_dir "directory"

doceng_load_help_file

Return the string used to load the *_help functions for a directory.

> doceng_load_help_file "directory"