The cdoc system generates a set of interlinked HTML pages that form the documentation set for the public objects defined in one or more C header pages. The set of pages is always recreated in its entirity when cdoc is run; incremental documentation creation is not possible.
NOTE: cdoc's parser is minimalist in nature. In consequence there is no guarantee that cdoc will correctly interpret the contents of files that do not compile correctly or that contain wierd layouts or obfuscated code.
If the C comments were formatted to underline function names or to form columns you can use the -f option. This will cause the overview and function descriptions to retain the same line layout that was used in the C comments. Otherwise each set of lines, separated by one or more blank lines is treated as a single paragraph and formatted accordingly by the web browser. During formatting cdoc will attempt to preserve the original line layout. As part of this process it expands tabs using a default width of 8 characters. If this gives an incorrect layout, the tab width can be changed with the -t option, e.g., -t=4 resets the tab width to four characters. You can embed HTML tags in the comment if that will improve readability. Tags controlling bolding, italics, underline, linebreak, preformatting, paragraphs, emphasis, keyboard input, headings, bulletted lists, numbered lists, and definition lists are all preserved and will affect the documentation layout. All others are converted into literal words by escaping < and >
HTML escape sequences should not be used in comments because they will be converted into literal text. & characters will be escaped to preserve them.
The generated pages are:
Links from the header pages, the alphabetic index and help page to one or more of the indexes are part of each page's heading. All items in any of the indexes link to the item's description.