Tornado Reference : Tornado Utilities

syngen

NAME

syngen - Tornado Reference documentation generator

SYNOPSIS

syngen [-config configFile] [-clean] [-d outDir] [-l logFile] [-h]
[-V] fileList

DESCRIPTION

Use this utility to collect synopsis-only output from fileList

This utility opens all the files from fileList and appends the found synopses specified through the -d outDir option.

The -config option allows to specify which config file to use in case of unknown file extension (know extensions yet are .c, .cc, .cpp, .tcl, .sh, .java, .s, .nr and .pcl) default value for configFile is set to C.

The -clean option is to specify that the synopses file will be cleaned, not built.

PARAMETERS

-clean - specifies that it is a synopses cleaning operation
-config - specifies configFile is to be used to parse fileList
-d - specifies that outDir is to be used to append all the synopses
-h - displays the help message
-l - specifies that logFile will be used as the log receiver
-V - to set the verbose mode on
fileList - list of files to be parsed by syngen

SEE ALSO

syngen, refgen, htmlLink, htmlBook, windHelpLib