Paradocs

Paradocs is a tool for generating Markdown documents based on Doxygen XML output, specifically for Primer and Blusher.

Usage

Create a paradocs.xml file and use the paradocs command in the same directory.

paradocs.xml

Paradocs is not a fully automated tool. You have to write some information to tell Paradocs which classes should be documented and which files should be input.

All paradocs.xml files starts with <paradocs> root tag.

<project>

The project tag is describes the meta information of a project.

The child tags are,

• <name>: Name of the project.
• <description>: A brief description of the project.
• <version>: Optional. The software version number. Default is an empty string.
• <namespace>: Optional. The C++ namespace. Default is an empty string.
• <docdir>: The directory path of XML files generated by Doxygen.
• <outdir>: Optional. Output directory. Default value is paradocs.
• <basepath>: Optional. If this is set, Paraocs will prepend this path to the links. Default value is /.

<category>

A category tag organize the classes. It must contain one name tag, which have a unique value within the project.

<class>

This is the core tag of Paradocs. Each class documentation file is generated based on this tag.

This tag have some attributes.

• namespace: Namespace of a class.
• file: A class XML file generated by Doxygen.

And the child tags are,

• <name>: Full name of the class, without namespace. e.g. Unicode::Scalar.
• <include>: Include file for using this class. e.g. <primer/string.h>.