extdoc

NAME

extdoc - Extract documentation from specially-commented C files

SYNOPSIS

extdoc [ -v ] [ --version ] [ -d ] [ --debug ] [ -h ] [ --html ] [ -t ] [ --text ] [ -a ] [ --ANSI ] [ -k ] [ --KR ] [ --polis ] 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
--text: Write documentation in text format. This writes a file pkgDoc.txt. This option may be used in conjunction with the --html option.
-h
--html: Write documentaion in HTML format. This writes four files. pkgExtAbs.html and pkgAllAbs.html contain abstracts for externally-visible functions and all functions respectively. pkgExtDet.html and pkgAllDet.html contain detailed information for externally-visible functions and all functions respectively. If the package contains any functions defining commands, a file named commandNameCmd.html is written for each command. 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 package, writing it to ntkDoc.txt, ntkExtAbs.html, ntkExtDet.html, ntkAllAbs.html, ntkAllDet.html, and look for K&R-style function definitions:

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

FILES

packageFile`.c`	C source file
package`.h`	Externally-visible header file
package`Int.h`	Internal header file
package`Doc.txt`	documentation file, ASCII format
package`ExtAbs.html`	documentation, abstracts of externally-visible functions, HTML format
package`ExtDet.html`	documentation, details of externally-visible functions, HTML format
package`AllAbs.html`	documentation, abstracts of all functions, HTML format
package`AllAbs.html`	documentation, abstracts of all functions, HTML format
package`AllDet.html`	documentation, details of all functions, HTML format
commandName`Cmd.html`	documentation on a command, HTML format

AUTHOR

Stephen Edwards
sedwards@alumni.caltech.edu