DITA-OT_CXX_Plugin/cxxapiref/doc/cxxFunction/cxxFunctionConst.dita
author Jonathan Harrington <jonathan.harrington@nokia.com>
Wed, 11 Aug 2010 14:49:30 +0100
changeset 4 468f4c8d3d5b
permissions -rw-r--r--
Orb version 0.2.0

<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved.		
		-->
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference xml:lang="en-us" outputclass="element" id="cxxFunctionConst">
    <title>cxxFunctionConst</title>
    <shortdesc>Used to describe a function with a <tt>const</tt> <i>cv-qualifier</i>.</shortdesc>
    <refbody>
        <section id="section_2A54A489B6CA4FAE897FD11B25175A01">
            <title>Description</title><p>This element is present when the function has a <tt>const</tt> <i>cv-qualifier</i>
. 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>
        </section>
        <example id="example_115617C5F81B42EABE4CAD6A61E05DC5">
            <title>Example</title><p>Given this code:</p>
            <codeblock>struct X {
    void g() const;
};</codeblock><p>Then function <tt>g</tt> would have the <tt>cxxFunctionConst</tt>
element:</p>
            <codeblock>&lt;cxxFunctionConst /&gt;</codeblock><p>If the mandatory attributes are present they must be set thus:</p>
            <codeblock>&lt;cxxFunctionConst name="const" value="const" /&gt;</codeblock>
        </example>
        <section conref="../packagedef.dita#cxxFunctionConst-reference/cxxFunctionConst-containedBy-section"/>
        <section conref="../packagedef.dita#cxxFunctionConst-reference/cxxFunctionConst-contains-section"/>
        <section conref="../packagedef.dita#cxxFunctionConst-reference/cxxFunctionConst-contentModel-section"/>
        <section conref="../packagedef.dita#cxxFunctionConst-reference/cxxFunctionConst-attList-section"/>
        <section conref="../packagedef.dita#cxxFunctionConst-reference/cxxFunctionConst-classValue-section"/>
    </refbody>
</reference>