extdoc

NAME

extdoc - Extract documentation from specially-commented C files

SYNOPSIS

extdoc [ -v ] [ --version ] [ -d ] [ --debug ] [ -h[=<dir>] ] [ --html[=<dir> ] ] [ -t[=<dir> ] ] [ --text[=<dir> ] ] [ -a ] [ --ANSI ] [ -k ] [ --KR ] [ --polis ] package [ package ...]

DESCRIPTION

Extdoc is a document-extraction tool for C source files. It examines a collection of C source and header files, collectively referred to as a package extracts ``structured'' comments embedded in the code, function prototypes, structures, etc. and generates documentation files.

OPTIONS

-v
--version: Print version information and exit.
-d
--debug: Enable debugging mode. This prints an enormous amount of cryptic information about what extdoc is doing.
-t[=<dir>]
--text[=<dir>]: Write documentation in text format. This writes a file pkgDoc.txt in the current directory or in the directory specified by the optional <dir> attribute. This option may be used in conjunction with the --html option.
-h[=<dir>]
--html[=<dir>]: Write documentation in HTML format. This writes many files (see the list of files below) into the current directory or in the directory specified by the optional <dir> attribute. This option may be used in conjunction with the --text option.
-a
--ANSI: Look for ANSI-style function declarations. This is the default. This should not be used with the --KR option.
-k
--KR: Look for K&R-style function declarations. This should not be used with the --ANSI option.
--polis: Use the polis file/function naming rules.

EXAMPLES

Extract the documentation in the tbl package, writing it to tblDoc.txt:

example% extdoc --text tbl

Extract text and HTML documentation from the ntk packages and look for K&R-style function definitions:

example% extdoc --text --html --KR ntk

Extract HTML documentation from the tbl and ntk packages, placing the resulting HTML files in /projects/vis/vis-devel/common/doc/html:

example% extdoc --html=/projects/vis/vis-devel/common/doc/html /projects/vis/vis-devel/common/src/tbl/tbl /projects/vis/vis-devel/common/src/ntk/ntk

FILES

A program name in parenthesis indicates the creator of the file.

packageFile`.c`	C source file
package`.h`	Externally-visible header file
package`Int.h`	Internal header file
package`Doc.txt`	documentation file, ASCII format (extdoc)
`commands.html`	documentation, an HTML frame for the commands (extindex)
`packages.html`	documentation, an HTML frame for the packages (extindex)
`cmdIndex.html`	documentation, an HTML list of all the commands with synopses (extindex)
`pkgIndex.html`	documentation, an HTML list of all the packages with synopses (extindex)
`credit.html`	documentation, the source of ext system (extindex)
package`Desc.html`	documentation, description of the package in HTML format (extdoc)
package`Title.html`	documentation, navigation through the three views (external, by function, and by file) in HTML format (extdoc)
package`Ext.html`	documentation, an HTML frame set for the externally-visible functions (extdoc)
package`AllByFunc.html`	documentation, an HTML frame set for the internal functions, sorted by function (extdoc)
package`AllByFile.html`	documentation, an HTML frame set for the internal functions, sorted by file (extdoc)
package`ExtAbs.html`	documentation, abstracts of externally-visible functions, HTML format (extdoc)
package`ExtDet.html`	documentation, details of externally-visible functions, HTML format (extdoc)
package`AllAbs.html`	documentation, abstracts of all functions, sorted by function name, HTML format (extdoc)
package`AllFile.html`	documentation, abstracts of all functions, sorted by file, HTML format (extdoc)
package`AllDet.html`	documentation, details of all functions, HTML format (extdoc)
commandName`Cmd.html`	documentation on a command, HTML format (extdoc)

AUTHOR

Stephen Edwards
University of California, Berkeley
sedwards@eecs.berkeley.edu