TOC

Source Documentation to HTML

This program converts documentation embedded in the source to HTML format. The result is a series of HTML files that are linked together.

The source can practically be any programming language.

usage Usage of the program
How to start the program to generate the documentation HTML files from the source.

syntax Documentation Description File Syntax
Commands and parameters that can be specified in the documentation description file.

format Formatting the embedded documentation
How the sections should be formatted, what formatting and definition command are available.

reference References in the source
How to insert a refernce to other section.

preprocess Usual preprocess commands
Without knowing Perl, here is the cookbook for some programming languages, how to set StartString, EndString and PreprocessComment

code Generating output code

TOC