<?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-contextcmds.qdoc -->
<title>Grouping Things | 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 >Grouping Things</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<link rel="prev" href="18-qdoc-commands-relating.html" />
<link rel="next" href="20-qdoc-commands-namingthings.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="18-qdoc-commands-relating.html">Relating Things</a>
<span class="naviSeparator"> ◦ </span>
<a class="nextPage" href="20-qdoc-commands-namingthings.html">Naming Things</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#commands">Commands</a></li>
<li class="level2"><a href="#ingroup">\ingroup</a></li>
<li class="level2"><a href="#inmodule">\inmodule</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Grouping Things</h1>
<span class="subtitle"></span>
<!-- $$$19-qdoc-commands-grouping.html-description -->
<div class="descr"> <a name="details"></a>
<p>The grouping commands relate classes to defined groups and modules. The groups are used when generating lists of related classes in the documentation, while the modules are elements of Qt's structure.</p>
<a name="commands"></a>
<h2 id="commands">Commands</h2>
<a name="ingroup-command"></a><a name="ingroup"></a>
<h3 >\ingroup</h3>
<p>The \ingroup command indicates that the given overview or documented class belongs to a certain group of related docmentation.</p>
<p>A class or overview may belong to many groups.</p>
<p>The \ingroup command's argument is a group name, but note that the command considers the rest of the line as part of its argument. Make sure that the group name is followed by a linebreak.</p>
<pre class="cpp">
<span class="operator">/</span> <span class="operator">*</span><span class="operator">!</span>
\<span class="keyword">class</span> <span class="type">QDir</span>
\brief The <span class="type">QDir</span> <span class="keyword">class</span> provides access to directory
structures and their contents<span class="operator">.</span>
\ingroup io
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="operator">*</span> <span class="operator">/</span>
</pre>
<p>This will include the QDir class in the <code>io</code> group, which means, for example, that QDir will appear on the list created by calling the <a href="13-qdoc-commands-topics.html#group-command">\group</a> command with the <code>io</code> argument.</p>
<p>To list overviews that are related to a certain group, you must generate the list explicitly using the <a href="12-0-qdoc-commands-miscellaneous.html#generatelist-command">\generatelist</a> command with the <code>related</code> argument.</p>
<p>See also <a href="13-qdoc-commands-topics.html#group-command">\group</a>.</p>
<a name="inmodule-command"></a><a name="inmodule"></a>
<h3 >\inmodule</h3>
<p>The \inmodule command relates a class to the module specified by the command's argument.</p>
<p>For the basic classes in Qt, a class's module is determined by its location, namely its directory. However, for extensions like ActiveQt and Qt Designer, a class must be related to a module explicitly.</p>
<p>The command's argument is a module name, but note that the command considers the rest of the line as part of its argument. Make sure that the module name is followed by a linebreak.</p>
<pre class="cpp">
<span class="comment">/*!
\class QDesignerTaskMenuExtension
\inmodule QtDesigner
* /
</span>
</pre>
<p>This ensures that the QDesignerTaskMenuExtension class is included in the Qt Designer module, which means, for example, that the class will appear on the list created by calling the <a href="12-0-qdoc-commands-miscellaneous.html#generatelist-command">\generatelist</a> command with the <code>{classesbymodule QtDesigner}</code> argument.</p>
<p>See also <a href="13-qdoc-commands-topics.html#module-command">\module</a> and <a href="12-0-qdoc-commands-miscellaneous.html#generatelist-command">\generatelist</a>.</p>
</div>
<!-- @@@19-qdoc-commands-grouping.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="18-qdoc-commands-relating.html">Relating Things</a>
<span class="naviSeparator"> ◦ </span>
<a class="nextPage" href="20-qdoc-commands-namingthings.html">Naming Things</a>
</p>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
749fcc421771b410525f39bd88a5732d
>
files
>
20
