diff -r d8fccb2cd802 -r 468f4c8d3d5b DITA-OT_CXX_Plugin/cxxapiref/doc/cxxVariable/cxxVariable.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/DITA-OT_CXX_Plugin/cxxapiref/doc/cxxVariable/cxxVariable.dita Wed Aug 11 14:49:30 2010 +0100 @@ -0,0 +1,60 @@ + + + + + cxxVariable + The <cxxVariable> element contains the elements necessary to describe a variable. + +
+ Description +

The <cxxVariable> element requires the id attribute so that it can be referenced + by other topics. <cxxVariable> also requires an <apiname> element to specify the variable + name, the the <cxxVariableDetail> element to hold the variable description.

+
+ + Example + <cxxClass id="a_class"> + <apiName>AClass</apiName> + <cxxClassDetail> + ... + </cxxClassDetail> + <cxxFunction id="a_class_1a0cd89cbef4c7224dab024bfa3182b99e"> + ... + </cxxFunction> + <cxxVariable id="a_class_1ae0375"> + <apiName>iFunctions</apiName> + <cxxVariableDetail> + <cxxVariableDefinition> + <cxxVariableAccessSpecifier value="protected"/> + <cxxVariableDeclaredType> + <apiRelation href="a_class_general_functions.xml#class_m_anim_general_functions">MAnimGeneralFunctions</apiRelation> *</cxxVariableDeclaredType> + <cxxVariableScopedName>CAnim</cxxVariableScopedName> + <cxxVariablePrototype>MAnimGeneralFunctions * iFunctions</cxxVariablePrototype> + <cxxVariableNameLookup>CAnim::iFunctions</cxxVariableNameLookup> + <cxxVariableAPIItemLocation> + <cxxVariableDeclarationFile name="filePath" value="C:/src/include/w32adll.h"/> + <cxxVariableDeclarationFileLine name="lineNumber" value="908"/> + </cxxVariableAPIItemLocation> + </cxxVariableDefinition> + <apiDesc> + <p>Pointer to a class containing functions implemented by the window server.</p> + <p>These are available to any <xref href="a_class.xml#a_class">CAnim</xref> derived class.</p> + <p>Note that this value is automatically set for you by the animation framework. You do not need to assign a value to this pointer.</p> + </apiDesc> + </cxxVariableDetail> + </cxxVariable> + <cxxClassInherits> + ... + </cxxClassInherits> +</cxxClass> + +
+
+
+
+
+ + \ No newline at end of file