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