/** * This is the documentation for ccdoc v0.8 source * code. For more information about ccdoc see the * ccdoc home page at: http://www.joelinoff.com/ccdoc. * * The documentation is organized into 6 packages. The packages * are described briefly in the table below. *
*
Phase | Description |
---|---|
DATABASE | The code associated with reading/writing the ccdoc database. | *
PHASE1 | The code that parses the input C++ files. | *
PHASE2 | The code that indexes unassociated entities. | *
PHASE3 | The code that generates the HTML output. | *
STATEMENT | The code associated with processing ccdoc statements. | *
UTILS | The code associated exception processing, log files, the internal string manager and switch handling. | *
** As you can see, ccdoc was run multiple times to support the creation * of multiple packages. * @author Joe Linoff * @version 0.8 * @pkgdoc @root * @pkgdoctid program */ /** * Convert the C++ input to statement::base objects. * @author Joe Linoff * @version 0.8 * @pkgdoc PHASE1 * @pkgdoctid module */ /** * Process C++ class methods that were defined as global functions. * This phase allows comments to be put into source files. * @author Joe Linoff * @version 0.8 * @pkgdoc PHASE2 * @pkgdoctid module */ /** * Generate HTML from the statement::base objects. * @author Joe Linoff * @version 0.8 * @pkgdoc PHASE3 * @pkgdoctid module */ /** * The exception classes, the output log classes, the string manager class, * and the switches. * @author Joe Linoff * @version 0.8 * @pkgdoc UTILS * @pkgdoctid module */ /** * The statement class definition and the comment class * definition. The comment class generates itself from * a statement object. It is very useful for processing * comments. * @author Joe Linoff * @version 0.8 * @pkgdoc STATEMENT * @pkgdoctid module */ /** * The database class definition. * @author Joe Linoff * @version 0.8 * @pkgdoc DATABASE * @pkgdoctid module */* % rm -f ../doc/webdocs/*.html * % ccdoc -v -db ../doc/webdocs/ccdoc.db -pkg UTILS \ * exceptions.h \ * log.h \ * strmgr.h \ * switches.h * % ccdoc -db ../doc/webdocs/ccdoc.db -pkg PHASE1 phase1*.h * % ccdoc -db ../doc/webdocs/ccdoc.db -pkg PHASE2 phase2*.h * % ccdoc -db ../doc/webdocs/ccdoc.db -pkg PHASE3 phase3*.h * % ccdoc -db ../doc/webdocs/ccdoc.db -pkg DATABASE database.h * % ccdoc -db ../doc/webdocs/ccdoc.db -pkg STATEMENT statement.h * % ccdoc -db ../doc/webdocs/ccdoc.db v0_8.txt * % ccdoc -db ../doc/webdocs/ccdoc.db -index * % ccdoc -db ../doc/webdocs/ccdoc.db \ * -html ../doc/webdocs/ \ * -header v0_8_hdr.txt \ * -srcurl ../../src/ \ * -root CCDOC \ * -rooturl ../users_guide.htm **