C++ API Reference Specialization

Purpose: The C++ API Reference specialization provides a basis for documenting C++ class libraries.

Prerequisite: API Reference specialization.

You can view the reference documentation for the C++ API Reference specialization.

Building

The C++ API Reference specialization provides the conductor.xml file to extend the base Ant targets with the following build targets:

cxxapiref2xhtml
Build the C++ API map for a sample C++ package to XHTML.

The run-ant.xml file executes this build targets on the sample content.

You should run the sample Ant build from the base directory for the DITA Open Toolkit, using a relative path to the C++ API Reference specialization:

ant -f integrator.xml
ant -f plugins\cxxapiref\run_ant.xml optionalTarget

You need only execute the install_plugin.xml file after initial installation or update of any plugin.

Contents

The specialization includes subdirectories with the following contents:

doc
The source files and output for the documentation.
dtd
DTDs for the document type for the API Reference specialization.
out
Formatted sample output files from the Ant build.
sample
Source files for an example of package content.
xsl
Transforms for producing the output of the Ant build.

Contributors

Paul Ross, Jonathan Harrington, Eleanor Weavers, Abigail Sidford, Robert Shaffer, Valentine Ogier-Galland, Jarno Elovirta

Copyright

Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).