cdk_doc

cdk_doc is a tool that helps you building html documentation for the caml libraries you write. It uses very simple convention to make web or man pages from .mli files. It can also be used to generate web pages from special files with .doc extensions.

Usage

 
cdk_doc [options] file.doc
cdk_doc [options] file1.mli file2.mli ...

Available options are:

-man_dir "dir" : Generate man pages. Generated pages should go in "dir".
-html_dir "dir" : Generate web pages. Generated pages should go in "dir".

Conventions used for the generation

All the documentation is inserted in caml files as comments. You'll need to tag your comments in order cdk_doc to understand them. A comment is tagged if you start it with some predefined char. Here are the different beginning of comments understood by cdk_doc:

"(* " : standard comment. The content of the comment should be some valid html.
"(*1" : Start a new section. The content of the comment is the name of this section.
"(*2" : Start a new subsection. The content of the comment is the name of this subsection.
"(*:module[: comments]*)" : Include a link to the file module.html generated from module.mli (only in .doc files).

If a comment contains the string "$id", all following untagged comments are treated as if starting by "(*d".

In all your comments, if you write something inside "[]", it will be displayed as code (TT tag). If you write something inside "{{" ... "}}", it will be printed as preformated code.

Example

Here is an example of an interface and its corresponding html page generated by cdk_doc.

Dernière modification: 26 mars 2001.