DOC_PARSE_TOOL¶

Launcheable module to parse a kindoc document from program files, and generate JSON data.

Usage

kink [Kink_options]... mod:kink/doc/DOC_PARSE_TOOL [Mod_options]... Module_base_paths...

The command finds Kink program files of public modules under Module_base_paths, and it parses a kinkdoc document from the program files. Then it outputs JSON data of the kinkdoc document.

By default, the command writes the JSON data to the standard output. If `--output` option is specified, the command writes the JSON data to the specified file.

For detailed usage and information of the toolchain, refer to “Kinkdoc: API Documentation system” chapter of the manual.

Mod_options

• --title {Title} : gives the title of the kinkdoc document.

• --overview {Overview_file_path} : gives the file path of a program file which contains kinkdoc comment chunks of the overview text.

• --output {Output_file_path} : gives the file path of the output JSON data.

Exit statuses

If the command succeeds, it exits with 0 as the exit status.

If the command fails, it exits with non-zero exit status.

6.44.1. DOC_PARSE_TOOL.main(Argv)¶

`main` is the launcher function of the module.