cxxClassDetail

The <cxxClassDetail> element provides detailed information about the structure and behaviors of the C++ class.

Description

The <cxxClassDetail> element is defined within <cxxClass>. In <cxxClassDetail> the <example> and <section> elements are provided to support the current specific C++ API reference. A class body can contain declarations of the members of the class, such as variables, classes, structs, and functions.

Example

<cxxClass id="class_c_array_fix_flat_3_01_t_uid_01_4">
	<apiName>CArrayFixFlat&lt; TUid &gt;</apiName>
	<cxxClassDetail>
		<cxxClassDefinition>
			<cxxClassAccessSpecifier value="public"/>
			<cxxClassDerivations>
				<cxxClassDerivation>
					<cxxClassDerivationAccessSpecifier value="public"/>
					<cxxClassBaseClass href="class_c_array_fix.xml#class_c_array_fix">CArrayFix&lt; TUid &gt;</cxxClassBaseClass>
				</cxxClassDerivation>
			</cxxClassDerivations>
			<cxxClassAPIItemLocation>
				<cxxClassDeclarationFile name="filePath" value="C:/include/e32base.h"/>
				<cxxClassDeclarationFileLine name="lineNumber" value="531"/>
				<cxxClassDefinitionFile name="filePath" value="C:/include/e32base.h"/>
				<cxxClassDefinitionFileLineStart name="lineNumber" value="521"/>
				<cxxClassDefinitionFileLineEnd name="lineNumber" value="536"/>
			</cxxClassAPIItemLocation>
		</cxxClassDefinition>
		<apiDesc>
			<p>Template specialisation base class for arrays of <xref href="class_t_uid.xml#class_t_uid">TUid</xref> types implemented in a flat dynamic buffer.</p>
			<p>
				<xref href="class_t_uid.xml#class_t_uid">TUid</xref> </p>
		</apiDesc>
	</cxxClassDetail>
	<cxxFunction id="class_c_array_fix_flat_3_01_t_uid_01_4_1a3b0a085b65c307ad4937a6c7c4bb767a">
		<apiName>~CArrayFixFlat</apiName>
		<cxxFunctionDetail>
			...
		</cxxFunctionDetail>
	</cxxFunction>
	<cxxFunction id="class_c_array_fix_flat_3_01_t_uid_01_4_1afd277b81e961b25f35b92dbc90f8d97c">
		<apiName>SetReserveL</apiName>
		<cxxFunctionDetail>
            ...
		</cxxFunctionDetail>
	</cxxFunction>
	<cxxClassInherits>
		<cxxClassInheritsDetail>
			...
		</cxxClassInheritsDetail>
	</cxxClassInherits>
</cxxClass>

Contained by

cxxClass

Contains

apiDesc, apiImpl, cxxClassDefinition example, section,

Content Model

(cxxClassDefinition (optional) then apiDesc, then (example, or section, or apiImpl, (any number) ))

Inheritance

topic/body reference/refbody apiRef/apiDetail apiClassifier/apiClassifierDetail cxxClass/cxxClassDetail