|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
5 <head> |
|
6 <title>C++ API Reference Specialization</title> |
|
7 </head> |
|
8 <body><div><h1>C++ API Reference Specialization</h1> |
|
9 <p><strong>Purpose:</strong> |
|
10 The C++ API Reference specialization provides a basis for documenting |
|
11 C++ class libraries. |
|
12 </p> |
|
13 <p><strong>Prerequisite:</strong> |
|
14 API Reference specialization. |
|
15 </p> |
|
16 <p>You can view the <a href="doc/frameset.html">reference |
|
17 documentation</a> for the C++ API Reference specialization.</p> |
|
18 <div><h2>Building</h2> |
|
19 <p>The C++ API Reference specialization provides the conductor.xml file |
|
20 to extend the base Ant targets with the following build targets:</p> |
|
21 <dl> |
|
22 <dt>cxxapiref2xhtml</dt> |
|
23 <dd>Build the C++ API map for a sample C++ package to XHTML.</dd> |
|
24 </dl> |
|
25 <p>The run-ant.xml file executes this build targets on the sample |
|
26 content.</p> |
|
27 <p>You should run the sample Ant build from the base directory for the DITA |
|
28 Open Toolkit, using a relative path to the C++ API Reference specialization:</p> |
|
29 <pre>ant -f integrator.xml |
|
30 ant -f plugins\cxxapiref\run_ant.xml <i>optionalTarget</i></pre> |
|
31 <p>You need only execute the install_plugin.xml file after initial |
|
32 installation or update of any plugin.</p> |
|
33 </div> |
|
34 <div><h2>Contents</h2><p>The specialization includes subdirectories |
|
35 with the following contents:</p><dl> |
|
36 <dt>doc</dt> |
|
37 <dd>The source files and output for the documentation.</dd> |
|
38 <dt>dtd</dt> |
|
39 <dd>DTDs for the document type for the API Reference specialization.</dd> |
|
40 <dt>out</dt> |
|
41 <dd>Formatted sample output files from the Ant build.</dd> |
|
42 <dt>sample</dt> |
|
43 <dd>Source files for an example of package content.</dd> |
|
44 <dt>xsl</dt> |
|
45 <dd>Transforms for producing the output of the Ant build.</dd> |
|
46 </dl></div> |
|
47 <div><h2>Contributors</h2><p>Paul Ross, Jonathan Harrington, Eleanor Weavers, Abigail Sidford, Robert Shaffer, Valentine Ogier-Galland, Jarno Elovirta</p> |
|
48 </div> |
|
49 </div> |
|
50 </body> |
|
51 </html> |