DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionAPIItemLocation.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="cxxFunctionAPIItemLocation">
       
     8     <title>cxxFunctionAPIItemLocation</title>
       
     9     <shortdesc>Describes the location of a function in the original C++ source code.</shortdesc>
       
    10     <refbody>
       
    11         <section id="section_58479B29DC4E4A5DB978B65C636F387A">
       
    12             <title>Description</title><p>Describes the location of a function in the original C++ source code.</p>
       
    13         </section>
       
    14         <example id="example_85FA9ADE455D48D9A46A4FFDE65EBF81">
       
    15             <title>Example</title><p>Given this code in <filepath>inc/a.h</filepath>:</p>
       
    16             <codeblock>/**
       
    17 @param aBuf The buffer
       
    18 */
       
    19 void g(const char* aBuf=0);
       
    20             </codeblock><p>And this code in <filepath>src/a.cpp</filepath>:</p>
       
    21             <codeblock>#include "a.h"
       
    22 
       
    23 void g(const char* aBuffer)
       
    24 {
       
    25 	// Implementation
       
    26 }
       
    27             </codeblock>
       
    28             <p>Then function <tt>g</tt> would have the <tt>cxxFunctionAPIItemLocation</tt>
       
    29 element:</p>
       
    30             <codeblock>&lt;cxxFunctionAPIItemLocation&gt;
       
    31   &lt;cxxFunctionDeclarationFile name="filePath" value="inc/a.h"/&gt;
       
    32   &lt;cxxFunctionDeclarationFileLine name="lineNumber" value="5"/&gt;
       
    33   &lt;cxxFunctionDefinitionFile name="filePath" value="src/a.cpp"/&gt;
       
    34   &lt;cxxFunctionDefinitionFileLineStart name="lineNumber" value="4"/&gt;
       
    35   &lt;cxxFunctionDefinitionFileLineEnd name="lineNumber" value="7"/&gt;
       
    36 &lt;/cxxFunctionAPIItemLocation&gt;
       
    37             </codeblock>
       
    38         </example>
       
    39         <section conref="../packagedef.dita#cxxFunctionAPIItemLocation-reference/cxxFunctionAPIItemLocation-containedBy-section"/>
       
    40         <section conref="../packagedef.dita#cxxFunctionAPIItemLocation-reference/cxxFunctionAPIItemLocation-contains-section"/>
       
    41         <section conref="../packagedef.dita#cxxFunctionAPIItemLocation-reference/cxxFunctionAPIItemLocation-contentModel-section"/>
       
    42         <section conref="../packagedef.dita#cxxFunctionAPIItemLocation-reference/cxxFunctionAPIItemLocation-attList-section"/>
       
    43         <section conref="../packagedef.dita#cxxFunctionAPIItemLocation-reference/cxxFunctionAPIItemLocation-classValue-section"/>
       
    44     </refbody>
       
    45 </reference>