prio/cxxapiref
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>C++ API Reference Specialization</title> </head> <body><div><h1>C++ API Reference Specialization</h1> <p><strong>Purpose:</strong> The C++ API Reference specialization provides a basis for documenting C++ class libraries. </p> <p><strong>Prerequisite:</strong> API Reference specialization. </p> <p>You can view the <a href="doc/frameset.html">reference documentation</a> for the C++ API Reference specialization.</p> <div><h2>Building</h2> <p>The C++ API Reference specialization provides the conductor.xml file to extend the base Ant targets with the following build targets:</p> <dl> <dt>cxxapiref2xhtml</dt> <dd>Build the C++ API map for a sample C++ package to XHTML.</dd> </dl> <p>The run-ant.xml file executes this build targets on the sample content.</p> <p>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:</p> <pre>ant -f integrator.xml ant -f plugins\cxxapiref\run_ant.xml <i>optionalTarget</i></pre> <p>You need only execute the install_plugin.xml file after initial installation or update of any plugin.</p> </div> <div><h2>Contents</h2><p>The specialization includes subdirectories with the following contents:</p><dl> <dt>doc</dt> <dd>The source files and output for the documentation.</dd> <dt>dtd</dt> <dd>DTDs for the document type for the API Reference specialization.</dd> <dt>out</dt> <dd>Formatted sample output files from the Ant build.</dd> <dt>sample</dt> <dd>Source files for an example of package content.</dd> <dt>xsl</dt> <dd>Transforms for producing the output of the Ant build.</dd> </dl></div> <div><h2>Contributors</h2><p>Paul Ross, Jonathan Harrington, Eleanor Weavers, Abigail Sidford, Robert Shaffer, Valentine Ogier-Galland, Jarno Elovirta</p> </div> <div><h2>Copyright</h2><p>Copyright (c) 2009-2011 Nokia Corporation and/or its subsidiary(-ies).</p> </div> </div> </body> </html>
About
Unofficial version of the DITA OT C++ specialisation plug-in
Resources
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published