RADE

C++ API Documentation Generator

mkmancpp

Generating documentation for C++ header files

Quick Reference

Abstract

mkmancpp is a tool that parses the declarations and documentation comments in a set of source files and produces a set of HTML pages describing entity (Class, Interface, Constructor, Method Global, function, Macro, Collection, Enumeration, Operator, Structure, typedef).

Synopsis
Usage
Examples
References

Synopsis

mkmancppM [-h] [-W <path>] [-o <path>] [-private] [-docPrivateMember] [-productID <name>] [-htmlfooter <path>] [-stylesheet <path>]

`-h`	help
`-W`	full path of the workspace to document
`-o path`	HTML output directory, which will be created if it does not already exists. If this option is not used, then the default output path is '/Doc/generated/refman'. Note that the command will failed if this directory already exists.
`-private`	scan PrivateInterfaces directories
`-docPrivateMember`	define if documentation for private member objects is generated
`-productID <name>`	Define the product name used in all page titles
`-htmlfooter <path>`	Define the full path name of the HTML footer for all pages
`-stylesheet <path>`	Define the full path name of the HTML style sheet

[Top]

Usage

Run mkmancpp for the C++ classes and interfaces of your framework.

If the option -w is not edited to define the path of the workspace to document, mkmancpp will use the path of the current workspace. When mkmancpp runs, errors are issued as lines beginning with # mkmdocman-ERROR and a short explanation of the error found.

html files are generated in the Doc\generated\refman directory located in your workspace root directory. Doc is at the same level than your framework directories.

refman contains:

A directory and a file per framework:
- The directory contains a html file for each existing header file, that contains the documentation extracted from the header file and that has the same name than the class or interface, but is suffixed with htm.
- A file per framework that contains the framework object list
Three files:
- AllNames.htm contains an index of all the classes, methods, enums, etc.
- main.htm contains the list of frameworks
- tree.htm contains the classes and interfaces arranged using their inheritance tree structure

[Top]

Examples

This command parse the current workspace and generated the html document of the c++ source files.

mkmancpp

This command parse the workspace myWs and generated the html document in the directory /u/users/UserName/myWs/htmlDoc.

mkmancpp -o /u/users/UserName/myWs/htmlDoc -W /u/users/UserName/myWs

[Top]

References

[1]	CAA V5 C++ Interface and Class Documentation Rules
[Top]

History

Version: 1 [Sept 2001]	Document created
[Top]