qttools5-doc-html 5.9.5-0ubuntu1 / usr / share / qt5 / doc / qdoc / 23-qdoc-configuration-cppvariables.html

This file is indexed.

/usr/share/qt5/doc/qdoc/23-qdoc-configuration-cppvariables.html is in qttools5-doc-html 5.9.5-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdoc-manual-qdocconf.qdoc -->
  <title>C++ Specific Configuration Variables | QDoc Manual 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >C++ Specific Configuration Variables</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="prev" href="22-creating-help-project-files.html" />
  <link rel="next" href="24-qdoc-configuration-htmlvariables.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="22-creating-help-project-files.html">Creating Help Project Files</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="24-qdoc-configuration-htmlvariables.html">HTML Specific Configuration Variables</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#cpp-ignoredirectives">Cpp.ignoredirectives</a></li>
<li class="level1"><a href="#cpp-ignoretokens">Cpp.ignoretokens</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">C++ Specific Configuration Variables</h1>
<span class="subtitle"></span>
<!-- $$$23-qdoc-configuration-cppvariables.html-description -->
<div class="descr"> <a name="details"></a>
<p>The C++ specific configuration variables are provided to avoid erroneous documentation due to non-standard C++ constructs.</p>
<a name="cpp-ignoredirectives-variable"></a><a name="cpp-ignoredirectives"></a>
<h2 id="cpp-ignoredirectives">Cpp.ignoredirectives</h2>
<p>The <code>Cpp.ignoredirectives</code> variable makes QDoc ignore the specified non-standard constructs, within C++ source code.</p>
<p>If not specified by the <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoretokens">Cpp.ignoretokens</a></code> or <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoredirectives">Cpp.ignoredirectives</a></code> variables, non-standard constructs (typically macros) can result in erroneous documentation.</p>
<pre class="cpp plain">

  Cpp.ignoredirectives = Q_DECLARE_INTERFACE \
                         Q_DECLARE_OPERATORS_FOR_FLAGS \
                         Q_DECLARE_PRIVATE \
                         Q_DECLARE_PUBLIC \
                         Q_DISABLE_COPY \
                         Q_DUMMY_COMPARISON_OPERATOR \
                         Q_ENUMS \
                         Q_FLAGS \
                         Q_INTERFACES \
                         __attribute__

</pre>
<p>makes sure that when processing the code below, for example, QDoc will simply ignore the 'Q_ENUMS' and 'Q_FLAGS' expressions:</p>
<pre class="cpp">

  <span class="keyword">class</span> Q_CORE_EXPORT <span class="type"><a href="../qtcore/qt.html">Qt</a></span> {
      Q_OBJECT
      Q_ENUMS(Orientation TextFormat BackgroundMode
              DateFormat ScrollBarPolicy FocusPolicy
              ContextMenuPolicy CaseSensitivity
              LayoutDirection ArrowType)
      Q_ENUMS(ToolButtonStyle)
      Q_FLAGS(Alignment)
      Q_FLAGS(Orientations)
      Q_FLAGS(DockWidgetAreas)

    <span class="keyword">public</span>:
      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
  };

</pre>
<p>The <a href="../qtcore/qobject.html#Q_OBJECT">Q_OBJECT</a> macro, however, is an exception: QDoc recognizes this particular non-standard construct, so there is no need specifying it using the <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoredirectives">Cpp.ignoredirectives</a></code> variable.</p>
<p>Regarding the Q_CORE_EXPORT macro; see the documentation of the <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoretokens">Cpp.ignoretokens</a></code> variable.</p>
<p>See also <a href="23-qdoc-configuration-cppvariables.html#cpp-ignoretokens">Cpp.ignoretokens</a>.</p>
<a name="cpp-ignoretokens-variable"></a><a name="cpp-ignoretokens"></a>
<h2 id="cpp-ignoretokens">Cpp.ignoretokens</h2>
<p>The <code>Cpp.ignoretokens</code> variable makes QDoc ignore the specified non-standard constructs, within C++ source code.</p>
<p>If not specified by the <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoretokens">Cpp.ignoretokens</a></code> or <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoredirectives">Cpp.ignoredirectives</a></code> variables, non-standard constructs (typically macros) can result in erroneous documentation.</p>
<p>In <a href="21-2-qtgui-qdocconf.html">qtgui.qdocconf</a>:</p>
<pre class="cpp plain">

  Cpp.ignoretokens = QAXFACTORY_EXPORT \
                     QM_EXPORT_CANVAS \
                     ..&#x2e;
                     Q_COMPAT_EXPORT \
                     Q_CORE_EXPORT \
                     Q_EXPLICIT \
                     Q_EXPORT \
                     ..&#x2e;
                     Q_XML_EXPORT

</pre>
<p>makes sure that when processing the code below, for example, QDoc will simply ignore the 'Q_CORE_EXPORT' expression:</p>
<pre class="cpp">

  <span class="keyword">class</span> Q_CORE_EXPORT <span class="type"><a href="../qtcore/qt.html">Qt</a></span> {
      Q_OBJECT
      Q_ENUMS(Orientation TextFormat BackgroundMode
              DateFormat ScrollBarPolicy FocusPolicy
              ContextMenuPolicy CaseSensitivity
              LayoutDirection ArrowType)
      Q_ENUMS(ToolButtonStyle)
      Q_FLAGS(Alignment)
      Q_FLAGS(Orientations)
      Q_FLAGS(DockWidgetAreas)
    <span class="keyword">public</span>:
      <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
  };

</pre>
<p>Regarding the <a href="../qtcore/qobject.html#Q_OBJECT">Q_OBJECT</a>, Q_ENUMS and Q_FLAGS macros; see the documentation of the <code><a href="23-qdoc-configuration-cppvariables.html#cpp-ignoredirectives">Cpp.ignoredirectives</a></code> variable.</p>
<p>See also <a href="23-qdoc-configuration-cppvariables.html#cpp-ignoredirectives">Cpp.ignoredirectives</a>.</p>
</div>
<!-- @@@23-qdoc-configuration-cppvariables.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="22-creating-help-project-files.html">Creating Help Project Files</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="24-qdoc-configuration-htmlvariables.html">HTML Specific Configuration Variables</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.