cxxFile

The <cxxFile> element contains all the global APIs of a component.

Description

<cxxFile> requires the attribute id so that it may be linked to from other topics.

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:

<cxxFile> must contain the element <cxxFileAPIItemLocation> to give the path to the file being described.

Example

<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>

Contained by

Contains

apiName, apiSyntax, cxxFileAPIItemLocation prolog, related-links, shortdesc,

Content Model

(apiSyntax, then apiName, then shortdesc, then prolog, then related-links, then cxxFileAPIItemLocation )

Inheritance

topic/topic reference/reference apiRef/apiRef apiPackage/apiPackage cxxFile/cxxFile