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="cxxFile">

     8     <title>cxxFile</title>

     9     <shortdesc>The &lt;cxxFile&gt; element contains all the global APIs of a component.</shortdesc>

    10     <refbody>

    11         <section>

    12             <title>Description</title>

    13             <p>&lt;cxxFile&gt; requires the attribute <i>id</i> so that it may be linked to from other topics.</p>

    14             <p>The &lt;cxxFile&gt; element must contain the file name within the element &lt;apiname&gt;. &lt;cxxFile&gt; 

    15             can also contain zero or more of the following elements to describe global APIs:</p>

    16             <ul>

    17                 <li>&lt;cxxFunction&gt;</li>

    18                 <li>&lt;cxxDefine&gt;</li>

    19                 <li>&lt;cxxVariable&gt;</li>

    20                 <li>&lt;cxxEnumeration&gt;</li>

    21                 <li>&lt;cxxTypedef&gt;</li>

    22             </ul>

    23             <p>&lt;cxxFile&gt; must contain the element &lt;cxxFileAPIItemLocation&gt; to give the path to the file 

    24             being described.</p>

    25         </section>

    26         <example><title>Example</title>

    27         <codeblock>&lt;cxxFile id="commsdebugutility_8h"&gt;

    28 	<apiName>commsdebugutility.h</apiName>

    29 	<cxxVariable id="commsdebugutility_8h_1a176351e3ce0f0e736bc6a7d8e2dcda59">

    30 		<apiName>KLogBufferSize</apiName>

    31 		<cxxVariableDetail>

    32 			...

    33 		</cxxVariableDetail>

    34 	</cxxVariable>

    35 	<cxxFileAPIItemLocation>

    36 		<cxxFileDeclarationFile name="filePath" value="C:/src/include/comms-infras/commsdebugutility.h"/>

    37 	</cxxFileAPIItemLocation>

    38 &lt;/cxxFile&gt;</codeblock>

    39         </example>

    40         <section conref="../packagedef.dita#cxxFile-reference/cxxFile-containedBy-section"/>

    41         <section conref="../packagedef.dita#cxxFile-reference/cxxFile-contains-section"/>

    42         <section conref="../packagedef.dita#cxxFile-reference/cxxFile-contentModel-section"/>

    43         <section conref="../packagedef.dita#cxxFile-reference/cxxFile-attList-section"/>

    44         <section conref="../packagedef.dita#cxxFile-reference/cxxFile-classValue-section"/>

    45     </refbody>

    46 </reference>