DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionVolatile.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="cxxFunctionVolatile">
       
     8     <title>cxxFunctionVolatile</title>
       
     9     <shortdesc>Used to describe a function with a <tt>volatile</tt> <i>cv-qualifier</i>.
       
    10     </shortdesc>
       
    11     <refbody>
       
    12         <section id="section_B63FF10B2B1042BA83D4D0A8EFBA42D6">
       
    13             <title>Description</title><p>This element is present when the function has a <tt>volatile</tt>
       
    14                 <i>cv-qualifier</i>
       
    15 . This has two mandatory attributes; name and value (see example below).</p><p>See ISO/IEC 14882:2003(E) 7.1.5.1 The cv-qualifiers [dcl.type.cv]</p>
       
    16         </section>
       
    17         <example id="example_3360D444B3304F9E9E519513D9221AE0">
       
    18             <title>Example</title><p>Given this code:</p>
       
    19             <codeblock>struct X {
       
    20     void g() volatile;
       
    21 };</codeblock><p>Then function <tt>g</tt> would have the <tt>cxxFunctionVolatile</tt>
       
    22 element:</p>
       
    23             <codeblock>&lt;cxxFunctionVolatile /&gt;</codeblock><p>If the mandatory attributes are present they must be set thus:</p>
       
    24             <codeblock>&lt;cxxFunctionVolatile name="volatile" value="volatile" /&gt;</codeblock>
       
    25         </example>
       
    26         <section conref="../packagedef.dita#cxxFunctionVolatile-reference/cxxFunctionVolatile-containedBy-section"/>
       
    27         <section conref="../packagedef.dita#cxxFunctionVolatile-reference/cxxFunctionVolatile-contains-section"/>
       
    28         <section conref="../packagedef.dita#cxxFunctionVolatile-reference/cxxFunctionVolatile-contentModel-section"/>
       
    29         <section conref="../packagedef.dita#cxxFunctionVolatile-reference/cxxFunctionVolatile-attList-section"/>
       
    30         <section conref="../packagedef.dita#cxxFunctionVolatile-reference/cxxFunctionVolatile-classValue-section"/>
       
    31     </refbody>
       
    32 </reference>