DITA-OT_CXX_Plugin/cxxapiref/doc/cxxAPIMap/cxxAPIMap.dita
author Jonathan Harrington <jonathan.harrington@nokia.com>
Wed, 11 Aug 2010 14:49:30 +0100
changeset 4 468f4c8d3d5b
permissions -rw-r--r--
Orb version 0.2.0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     1
<?xml version="1.0" encoding="UTF-8"?>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     2
<!--
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     3
Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     4
All rights reserved.		
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     5
		-->
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     6
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     7
<reference xml:lang="en-us" outputclass="element" id="cxxAPIMap">
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     8
    <title>cxxAPIMap</title>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     9
    <shortdesc>The &lt;cxxAPIMap&gt; element provides the name of the C++ API Reference
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    10
and all the elements necessary to describe the package, or set of packages,
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    11
and its components.</shortdesc>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    12
    <refbody>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    13
        <section>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    14
            <title>Description</title>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    15
            <p>The containing element for a map is the &lt;cxxAPIMap&gt; element. 
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    16
            &lt;cxxAPIMap&gt; requires title and id attributes. </p> 
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    17
            <p>&lt;cxxAPIMap&gt; can also contain any number of the elements &lt;cxxFileRef&gt;, 
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    18
            &lt;cxxClassRef&gt;, &lt;cxxStructRef&gt; and &lt;cxxUnionRef&gt; to add references 
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    19
            to topics.</p>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    20
        </section>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    21
        <example>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    22
            <title>Example</title>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    23
            <codeblock>&lt;cxxAPIMap id=&quot;GUID-A1E43BB6-B43A-38A0-870F-29A553C534EC&quot; title=&quot;AMap&quot;&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    24
            &lt;cxxStructRef href=&quot;GUID-4D736120-454B-3952-ADFA-FEC7BDDE18F2.xml&quot; navtitle=&quot;AClass::AStruct&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    25
            &lt;cxxClassRef href=&quot;GUID-1F65F1EB-791C-32A4-A05E-3262BA816EF6.xml&quot; navtitle=&quot;AClass&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    26
            &lt;cxxFileRef href=&quot;GUID-15161A9C-9AC4-3B34-AADE-5294E5C7CCC2.xml&quot; navtitle=&quot;AFile.h&quot; /&gt;    
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    27
            &lt;cxxEnumRef href=&quot;GUID-4C504F67-7737-33A7-AA99-6F030423E4CB.xml&quot; navtitle=&quot;AClass::anEnum&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    28
            &lt;cxxFunctionRef href=&quot;GUID-1390F0BC-18FA-3E68-A5F7-25347A52A08C.xml&quot; navtitle=&quot;AClass::aFunction(aParam,anotherParam)&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    29
            &lt;cxxTypedefRef href=&quot;GUID-CB589BED-4E77-3CD9-83A8-516A4B47C223.xml&quot; navtitle=&quot;AClass::aTypeDef&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    30
            &lt;cxxUnionRef href=&quot;GUID-A6375D7C-47D4-38BB-946C-BF042C16F4BD.xml&quot; navtitle=&quot;AClass::uAUnion&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    31
            &lt;cxxDefineRef href=&quot;GUID-1EA4FECD-61BB-3D49-99B5-B4003993D383.xml&quot; navtitle=&quot;AClass::aDefine&quot; /&gt;    
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    32
            &lt;cxxVariableRef href=&quot;GUID-57906A69-F9F1-39FC-8A3E-6EC67BFBCFBA.xml&quot; navtitle=&quot;AClass::aVariable&quot; /&gt;
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    33
        &lt;/cxxAPIMap&gt;</codeblock>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    34
        </example>        
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    35
        <section conref="../packagedef.dita#cxxAPIMap-reference/cxxAPIMap-containedBy-section"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    36
        <section conref="../packagedef.dita#cxxAPIMap-reference/cxxAPIMap-contains-section"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    37
        <section conref="../packagedef.dita#cxxAPIMap-reference/cxxAPIMap-contentModel-section"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    38
        <section conref="../packagedef.dita#cxxAPIMap-reference/cxxAPIMap-attList-section"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    39
        <section conref="../packagedef.dita#cxxAPIMap-reference/cxxAPIMap-classValue-section"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    40
    </refbody>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    41
</reference>