<< tbx_build_gateway_loader Helper functions tbx_build_help_loader >>

Scilab Help >> Modules manager > Helper functions > tbx_build_help

tbx_build_help

Generate help files (toolbox compilation process)

Syntax

tbx_build_help(title)
tbx_build_help(title, help_path)

Arguments

title

Title of the chapter.

help_path

Directory where the files will be generated ; in a normal toolbox it should be the directory containing the build_help.sce script (which should be the script calling this function). Default is current directory.

Remark:

If you call tbx_build_help in scilab CLI (=NWNI) mode, help files will not be generated.

Examples

// Recommended usage
tbx_build_help("Toolbox Example", get_absolute_file_path('build_help.sce'))

See also


Report an issue
<< tbx_build_gateway_loader Helper functions tbx_build_help_loader >>