DITA-OT_CXX_Plugin/cxxapiref/doc/cxxDefine/cxxDefineNameLookup.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="cxxDefineNameLookup">
       
     8     <title>cxxDefineNameLookup</title>
       
     9     <shortdesc>Provides a unique identifier of the define.</shortdesc>
       
    10     <refbody>
       
    11         <section>
       
    12             <title>Description</title>
       
    13             <p>This element provides a way of  uniquely identifying a define in a body of DITA XML that 
       
    14             describes a body of C++ source code.</p><p>Implementations are free to write what they want in 
       
    15             this elements PCDATA but a "good" implementation would place some premium on the following:<ul>
       
    16                     <li>The text would be unique within a set of DITA XML files.</li>
       
    17                     <li>The text would be human readable.</li>
       
    18                     <li>The text would generally follow the lookup techniques use in the C++ standard (ISO/IEC 14882:2003(E)).</li>
       
    19                     <li>Any encoding used would be reversible.</li>
       
    20                 </ul>
       
    21             </p>
       
    22         </section>
       
    23         <example>
       
    24             <title>Example</title>
       
    25             <codeblock>&lt;cxxDefineNameLookup&gt;ENABLE_NETWORKING_PERFMETRICS&lt;/cxxDefineNameLookup&gt;</codeblock>
       
    26         </example>
       
    27         <section conref="../packagedef.dita#cxxDefineNameLookup-reference/cxxDefineNameLookup-containedBy-section"/>
       
    28         <section conref="../packagedef.dita#cxxDefineNameLookup-reference/cxxDefineNameLookup-contains-section"/>
       
    29         <section conref="../packagedef.dita#cxxDefineNameLookup-reference/cxxDefineNameLookup-contentModel-section"/>
       
    30         <section conref="../packagedef.dita#cxxDefineNameLookup-reference/cxxDefineNameLookup-attList-section"/>
       
    31         <section conref="../packagedef.dita#cxxDefineNameLookup-reference/cxxDefineNameLookup-classValue-section"/>
       
    32     </refbody>
       
    33 </reference>