diff -r d8fccb2cd802 -r 468f4c8d3d5b DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFile/cxxFile.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFile/cxxFile.dita Wed Aug 11 14:49:30 2010 +0100 @@ -0,0 +1,46 @@ + + + + + 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:

+
    +
  • <cxxFunction>
  • +
  • <cxxDefine>
  • +
  • <cxxVariable>
  • +
  • <cxxEnumeration>
  • +
  • <cxxTypedef>
  • +
+

<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> + +
+
+
+
+
+ + \ No newline at end of file