DITA-OT_CXX_Plugin/cxxapiref/doc/cxxClass/cxxClassDetail.dita
changeset 4 468f4c8d3d5b
equal deleted inserted replaced
3:d8fccb2cd802 4:468f4c8d3d5b
       
     1 <?xml version="1.0" encoding="UTF-8"?>
       
     2 <!--
       
     3 Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 All rights reserved.		
       
     5 		-->
       
     6 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
       
     7 <reference xml:lang="en-us" outputclass="element" id="cxxClassDetail">
       
     8     <title>cxxClassDetail</title>
       
     9     <shortdesc>The &lt;cxxClassDetail&gt; element provides detailed information
       
    10 about the structure and behaviors of the C++ class. </shortdesc>
       
    11     <refbody>
       
    12         <section>
       
    13             <title>Description</title>
       
    14             <p>The &lt;cxxClassDetail&gt; element is defined within &lt;cxxClass&gt;. 
       
    15             In &lt;cxxClassDetail&gt; the &lt;example&gt; and &lt;section&gt; 
       
    16             elements are provided to support the current specific C++ API reference. A class 
       
    17             body can contain declarations of the members of the class, such as variables, 
       
    18             classes, structs, and functions.</p>
       
    19         </section>
       
    20         <example><title>Example</title>
       
    21         <codeblock>&lt;cxxClass id=&quot;class_c_array_fix_flat_3_01_t_uid_01_4&quot;&gt;
       
    22 	&lt;apiName&gt;CArrayFixFlat&amp;lt; TUid &amp;gt;&lt;/apiName&gt;
       
    23 	&lt;cxxClassDetail&gt;
       
    24 		&lt;cxxClassDefinition&gt;
       
    25 			&lt;cxxClassAccessSpecifier value=&quot;public&quot;/&gt;
       
    26 			&lt;cxxClassDerivations&gt;
       
    27 				&lt;cxxClassDerivation&gt;
       
    28 					&lt;cxxClassDerivationAccessSpecifier value=&quot;public&quot;/&gt;
       
    29 					&lt;cxxClassBaseClass href=&quot;class_c_array_fix.xml#class_c_array_fix&quot;&gt;CArrayFix&amp;lt; TUid &amp;gt;&lt;/cxxClassBaseClass&gt;
       
    30 				&lt;/cxxClassDerivation&gt;
       
    31 			&lt;/cxxClassDerivations&gt;
       
    32 			&lt;cxxClassAPIItemLocation&gt;
       
    33 				&lt;cxxClassDeclarationFile name=&quot;filePath&quot; value=&quot;C:/include/e32base.h&quot;/&gt;
       
    34 				&lt;cxxClassDeclarationFileLine name=&quot;lineNumber&quot; value=&quot;531&quot;/&gt;
       
    35 				&lt;cxxClassDefinitionFile name=&quot;filePath&quot; value=&quot;C:/include/e32base.h&quot;/&gt;
       
    36 				&lt;cxxClassDefinitionFileLineStart name=&quot;lineNumber&quot; value=&quot;521&quot;/&gt;
       
    37 				&lt;cxxClassDefinitionFileLineEnd name=&quot;lineNumber&quot; value=&quot;536&quot;/&gt;
       
    38 			&lt;/cxxClassAPIItemLocation&gt;
       
    39 		&lt;/cxxClassDefinition&gt;
       
    40 		&lt;apiDesc&gt;
       
    41 			&lt;p&gt;Template specialisation base class for arrays of &lt;xref href=&quot;class_t_uid.xml#class_t_uid&quot;&gt;TUid&lt;/xref&gt; types implemented in a flat dynamic buffer.&lt;/p&gt;
       
    42 			&lt;p&gt;
       
    43 				&lt;xref href=&quot;class_t_uid.xml#class_t_uid&quot;&gt;TUid&lt;/xref&gt; &lt;/p&gt;
       
    44 		&lt;/apiDesc&gt;
       
    45 	&lt;/cxxClassDetail&gt;
       
    46 	&lt;cxxFunction id=&quot;class_c_array_fix_flat_3_01_t_uid_01_4_1a3b0a085b65c307ad4937a6c7c4bb767a&quot;&gt;
       
    47 		&lt;apiName&gt;~CArrayFixFlat&lt;/apiName&gt;
       
    48 		&lt;cxxFunctionDetail&gt;
       
    49 			...
       
    50 		&lt;/cxxFunctionDetail&gt;
       
    51 	&lt;/cxxFunction&gt;
       
    52 	&lt;cxxFunction id=&quot;class_c_array_fix_flat_3_01_t_uid_01_4_1afd277b81e961b25f35b92dbc90f8d97c&quot;&gt;
       
    53 		&lt;apiName&gt;SetReserveL&lt;/apiName&gt;
       
    54 		&lt;cxxFunctionDetail&gt;
       
    55             ...
       
    56 		&lt;/cxxFunctionDetail&gt;
       
    57 	&lt;/cxxFunction&gt;
       
    58 	&lt;cxxClassInherits&gt;
       
    59 		&lt;cxxClassInheritsDetail&gt;
       
    60 			...
       
    61 		&lt;/cxxClassInheritsDetail&gt;
       
    62 	&lt;/cxxClassInherits&gt;
       
    63 &lt;/cxxClass&gt;</codeblock>
       
    64         </example>
       
    65         <section conref="../packagedef.dita#cxxClassDetail-reference/cxxClassDetail-containedBy-section"/>
       
    66         <section conref="../packagedef.dita#cxxClassDetail-reference/cxxClassDetail-contains-section"/>
       
    67         <section conref="../packagedef.dita#cxxClassDetail-reference/cxxClassDetail-contentModel-section"/>
       
    68         <section conref="../packagedef.dita#cxxClassDetail-reference/cxxClassDetail-attList-section"/>
       
    69         <section conref="../packagedef.dita#cxxClassDetail-reference/cxxClassDetail-classValue-section"/>
       
    70     </refbody>
       
    71 </reference>