The following are the proposed tags that will be parsed from comments in "C" files by the c2html perl script. HTML documents for WWW viewing will result.
The tags listed below will be recognized by the c2html converter.
The syntax of the <AUTO> tag is:
If the optional EXTRACT keyword is present, then the routine declaration or the TCL verb usage information may also be automatically extracted, depending on the type of section.If you use the approved commenting style, you must specify the <AUTO> section's type by including one of the following lines after the <AUTO> tag:
Note that the EXTRACT keyword has no effect on MODULE sections.If none of these types is specified, AUTO assumes that it's dealing with a C function, and finds the function's name by reading the code.
At this point, if you want to specify a type it's probably easiest to just look at an example of the <AUTO> tag, but for the masochists, there's the list of translations that c2html will perform. Keep scrolling down in either case.
Don't read this if you can avoid it - look at the example instead. The following translations/rules apply to <AUTO> sections: