cxxStructDefinition

The <cxxStructDefinition> element is defined within <cxxStructDetail>. <cxxStructDefinition> represents the C++ struct declaration.

Description

A struct declaration specifies a new named reference type. A struct declaration can include the following members: public, protected or private, this is represented by the <cxxStructAccessSpecifier> element.

<cxxStructDefinition> requires the element <cxxStructAPIItemLocation> as its child.

Example

<cxxStructDefinition>
			<cxxStructAccessSpecifier value="public"/>
			<cxxStructDerivations>
				<cxxStructDerivation>
					<cxxStructDerivationAccessSpecifier value="public"/>
					<cxxStructBaseStruct href="struct_c_base.xml#struct_c_base">CBase</cxxStructBaseStruct>
				</cxxStructDerivation>
			</cxxStructDerivations>
			<cxxStructAPIItemLocation>
				<cxxStructDeclarationFile name="filePath" value="C:/src/include/e32base.h"/>
				<cxxStructDeclarationFileLine name="lineNumber" value="2812"/>
				<cxxStructDefinitionFile name="filePath" value="C:/src/include/e32base.h"/>
				<cxxStructDefinitionFileLineStart name="lineNumber" value="2784"/>
				<cxxStructDefinitionFileLineEnd name="lineNumber" value="2854"/>
			</cxxStructAPIItemLocation>
		</cxxStructDefinition>

Contained by

cxxStructDetail

Contains

cxxStructAPIItemLocation cxxStructAbstract cxxStructAccessSpecifier cxxStructDerivations cxxStructTemplateParameters

Content Model

(cxxStructAccessSpecifier (optional) then cxxStructAbstract (optional) then cxxStructDerivations (optional) then cxxStructTemplateParameters (optional) then cxxStructAPIItemLocation )

Inheritance

topic/section reference/section apiRef/apiDef apiClassifier/apiClassifierDef cxxStruct/cxxStructDefinition