<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved.
-->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xml:lang="en-us" outputclass="element" id="cxxFile">
<title>cxxFile</title>
<shortdesc>The <cxxFile> element contains all the global APIs of a component.</shortdesc>
<refbody>
<section>
<title>Description</title>
<p><cxxFile> requires the attribute <i>id</i> so that it may be linked to from other topics.</p>
<p>The <cxxFile> element must contain the file name within the element <apiname>. <cxxFile>
can also contain zero or more of the following elements to describe global APIs:</p>
<ul>
<li><cxxFunction></li>
<li><cxxDefine></li>
<li><cxxVariable></li>
<li><cxxEnumeration></li>
<li><cxxTypedef></li>
</ul>
<p><cxxFile> must contain the element <cxxFileAPIItemLocation> to give the path to the file
being described.</p>
</section>
<example><title>Example</title>
<codeblock><cxxFile id="commsdebugutility_8h">
<apiName>commsdebugutility.h</apiName>
<cxxVariable id="commsdebugutility_8h_1a176351e3ce0f0e736bc6a7d8e2dcda59">
<apiName>KLogBufferSize</apiName>
<cxxVariableDetail>
...
</cxxVariableDetail>
</cxxVariable>
<cxxFileAPIItemLocation>
<cxxFileDeclarationFile name="filePath" value="C:/src/include/comms-infras/commsdebugutility.h"/>
</cxxFileAPIItemLocation>
</cxxFile></codeblock>
</example>
<section conref="../packagedef.dita#cxxFile-reference/cxxFile-containedBy-section"/>
<section conref="../packagedef.dita#cxxFile-reference/cxxFile-contains-section"/>
<section conref="../packagedef.dita#cxxFile-reference/cxxFile-contentModel-section"/>
<section conref="../packagedef.dita#cxxFile-reference/cxxFile-attList-section"/>
<section conref="../packagedef.dita#cxxFile-reference/cxxFile-classValue-section"/>
</refbody>
</reference>