cxxTypedef

The <cxxTypedef> element provides the name of the C++ API typedef, all the elements necessary to describe the members that are introduced by the typedef declaration.

Description

The <cxxTypedef> element requires an ID attribute as an anchor point; this ID must always be specified. The ID attribute is referenced by the conref attribute and internal applications that refer to the <cxxTypedef> element content. The elements <apiName> and <cxxTypedefDetail> are required for this top-level container.

Example

<cxxTypedef id="GUID-D02ABE8F-2F4B-3625-8472-2ACAF38F47F1">
		<apiName>TRBuf</apiName>
		<cxxTypedefDetail>
			<cxxTypedefDefinition>
				<cxxTypedefAccessSpecifier value="public" />
				<cxxTypedefDeclaredType>TRBuf16</cxxTypedefDeclaredType>
				<cxxTypedefScopedName>Elements</cxxTypedefScopedName>
				<cxxTypedefPrototype>TRBuf16 TRBuf</cxxTypedefPrototype>
				<cxxTypedefNameLookup>Elements::TRBuf</cxxTypedefNameLookup>
				<cxxTypedefAPIItemLocation>
					<cxxTypedefDeclarationFile name="filePath" value="s:/epoc32/include/platform/elements/h_trbuf.h" />
					<cxxTypedefDeclarationFileLine name="lineNumber" value="104" />
				</cxxTypedefAPIItemLocation>
			</cxxTypedefDefinition>
			<apiDesc />
		</cxxTypedefDetail>
	</cxxTypedef>
            

Contained by

cxxUnion cxxClass cxxStruct

Contains

apiName, cxxTypedefDetail no-topic-nesting, prolog, related-links, shortdesc,

Content Model

(apiName, then shortdesc, then prolog, then cxxTypedefDetail then related-links, then (no-topic-nesting, ))

Inheritance

topic/topic reference/reference apiRef/apiRef apiValue/apiValue cxxTypedef/cxxTypedef