autogsdoc -V (return code: 1)
Usage:
autogsdoc [options] [files]
Options:
-InstanceVariablesAtEnd BOOL (YES)
put instance variable docs at end of class
-MakeFrames BOOL (NO)
if YES, create documentation pages for display in HTML frames
-MakeDependencies STR ("")
file to output dependency info for 'make' into
-Projects STR ("None")
explicit list of other projects to index
-WordMap special (nil)
dictionary used to preprocess (see docs)
-Up STR ("")
filename to link to from generated HTML
-GenerateParagraphMarkup BOOL (NO)
if YES, wrap paragraphs delimited by \n\n in <p> tags when possible
-DocumentInstanceVariables BOOL (YES)
document instance variables at all
-Standards BOOL (NO)
whether to insert information on standards compliance
-CleanTemplates BOOL (NO)
remove template files when cleaning
-Warn BOOL (NO)
produce warnings
-FunctionsTemplate STR ("")
file into which docs for functions should be consolidated
-SystemProjects STR ("None")
whether to include system projects in index
-DocumentAllInstanceVariables BOOL (NO)
document private instance variables
-HeaderDirectory STR (.)
directory to search for .h files
-Verbose BOOL (NO)
produce verbose output
-LocalProjects STR ("None")
whether to include other projects in index
-DocumentationDirectory STR (.)
directory to place generated files and search for gsdoc files
-IgnoreDependencies BOOL (NO)
ignore file mod times (always generate)
-DTDs String (nil)
If set, look for DTDs in the given directory
-TypedefsTemplate STR ("")
file into which docs for typedefs should be consolidated
-Declared STR ("")
specify where headers are to be documented as being found
-MacrosTemplate STR ("")
file into which docs for macros should be consolidated
-GenerateHtml BOOL (YES)
generate HTML output (as opposed to just gsdoc from source)
-Clean BOOL (NO)
remove all generated files
-VariablesTemplate STR ("")
file into which docs for variables should be consolidated
-Project STR ("Untitled")
head title name of this documentation
-ShowDependencies BOOL (NO)
log files being regenerated due to dependencies
-ConstantsTemplate STR ("")
file into which docs for constants should be consolidated
-Files STR ("")
name of file containing filenames to document
Files:
[.h files] Must be in 'HeaderDirectory'
[.m files] Absolute or relative path (from here)
[.gsdoc files] Must be in 'DocumentationDirectory'
autogsdoc --help (return code: 1)
Usage:
autogsdoc [options] [files]
Options:
-InstanceVariablesAtEnd BOOL (YES)
put instance variable docs at end of class
-MakeFrames BOOL (NO)
if YES, create documentation pages for display in HTML frames
-MakeDependencies STR ("")
file to output dependency info for 'make' into
-Projects STR ("None")
explicit list of other projects to index
-WordMap special (nil)
dictionary used to preprocess (see docs)
-Up STR ("")
filename to link to from generated HTML
-GenerateParagraphMarkup BOOL (NO)
if YES, wrap paragraphs delimited by \n\n in <p> tags when possible
-DocumentInstanceVariables BOOL (YES)
document instance variables at all
-Standards BOOL (NO)
whether to insert information on standards compliance
-CleanTemplates BOOL (NO)
remove template files when cleaning
-Warn BOOL (NO)
produce warnings
-FunctionsTemplate STR ("")
file into which docs for functions should be consolidated
-SystemProjects STR ("None")
whether to include system projects in index
-DocumentAllInstanceVariables BOOL (NO)
document private instance variables
-HeaderDirectory STR (.)
directory to search for .h files
-Verbose BOOL (NO)
produce verbose output
-LocalProjects STR ("None")
whether to include other projects in index
-DocumentationDirectory STR (.)
directory to place generated files and search for gsdoc files
-IgnoreDependencies BOOL (NO)
ignore file mod times (always generate)
-DTDs String (nil)
If set, look for DTDs in the given directory
-TypedefsTemplate STR ("")
file into which docs for typedefs should be consolidated
-Declared STR ("")
specify where headers are to be documented as being found
-MacrosTemplate STR ("")
file into which docs for macros should be consolidated
-GenerateHtml BOOL (YES)
generate HTML output (as opposed to just gsdoc from source)
-Clean BOOL (NO)
remove all generated files
-VariablesTemplate STR ("")
file into which docs for variables should be consolidated
-Project STR ("Untitled")
head title name of this documentation
-ShowDependencies BOOL (NO)
log files being regenerated due to dependencies
-ConstantsTemplate STR ("")
file into which docs for constants should be consolidated
-Files STR ("")
name of file containing filenames to document
Files:
[.h files] Must be in 'HeaderDirectory'
[.m files] Absolute or relative path (from here)
[.gsdoc files] Must be in 'DocumentationDirectory'