Go to the first, previous, next, last section, table of contents.


Conventions for .doc files

Documentation files (.doc suffix) should be written in texinfo format. The language is extended with the following commands (must be preceeded by a "@"):

  1. "cdk_doc{filename}{title}{comment}": Insert the documentation generated from "filename".doc at this point. A new node is generated, and the inserted text is included in a subsection of the current section. If "title" is empty, the title is "The -- Library", where -- is replaced by the basename of "filename". The node name is the basename of "filename", prefixed by the name of the upper node.
  2. "cdk_mli{filename}{title}{comment}": Insert the documentation generated from "filename".mli. If "title" is empty, the title is "The -- module" where -- is replaced by the basename of filename.
  3. "cdk_section{node}{title}{comment}": Create a new sub-section at this point. The node name is "node" prefixed by the name of the upper node.
  4. "end cdk_section": Terminates the current sub-section.
  5. "cdk_menu{level}": Generate menu items for sub-sections. If level is "0", items are generated for sub-sections only. If level is "1", items are generated for sub-sub-section only. This command must be included inside a "@menu" ... "@end menu" sequence.
  6. "cdk_escape{tag}{text}": "text" is included with escape sequences for "@", "{" and "}" characters. If "tag" is not empty, a "@<tag>" ... "@end <tag>" sequence is generated around the text.


Go to the first, previous, next, last section, table of contents.