summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-02-24 11:55:14 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-02-24 11:55:14 (GMT)
commita7bca792fd7c1ae7edf45a7aae67c7a3423d35e8 (patch)
treef9bf30985d5bede850fcbc3e3c0fbeb89fe1d7a7
parentd3a878209faa4e18102f41aeb3e700d88c46572b (diff)
downloadQt-a7bca792fd7c1ae7edf45a7aae67c7a3423d35e8.zip
Qt-a7bca792fd7c1ae7edf45a7aae67c7a3423d35e8.tar.gz
Qt-a7bca792fd7c1ae7edf45a7aae67c7a3423d35e8.tar.bz2
qdoc: More updating command descriptions.
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc256
1 files changed, 123 insertions, 133 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 7fcd92f..0ada405 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -6257,108 +6257,105 @@
classes in the documentation, while the modules are elements of
Qt's structure.
+ \section1 Commands
+
\target mainclass-command
- \section1 \\mainclass
+ \section2 \\mainclass
The \\mainclass command relates the documented class to
a group called mainclasses.
- The command must stand on its own line.
-
- For example:
+ The command must stand on its own line.
- \code
- / *!
- \class QWidget qwidget.h
- \brief The QWidget class is the base class of
- all user interface objects.
+ \code
+ / *!
+ \class QWidget qwidget.h
+ \brief The QWidget class is the base class of
+ all user interface objects.
- \mainclass
+ \mainclass
- ...
- * /
- \endcode
+ ...
+ * /
+ \endcode
- will ensure that the QWidget class is included in the \c
- mainclasses group, which means, for example, that the class
- will appear on the list created by calling the \l
- {generatelist-command} {\\generatelist} command with the \c
- mainclasses argument:
+ This will include the QWidget class in the \e mainclasses
+ group, which means, for example, that the class will appear on the
+ list created by calling the \l {generatelist-command}
+ {\\generatelist} command with the \c mainclasses argument:
- \l http://qt.nokia.com/doc/4.0/mainclasses.html
+ \l http://qt.nokia.com/doc/4.0/mainclasses.html
- See also \l {generatelist-command} {\\generatelist}.
+ \note The Qt documentation no longer includes the \e mainclasses
+ page.
+ See also \l {generatelist-command} {\\generatelist}.
\target ingroup-command
- \section1 \\ingroup
+ \section2 \\ingroup
The \\ingroup command indicates that the given
overview or documented class belongs to a certain group of
related docmentation.
- A class or overview may belong to many groups.
+ A class or overview may belong to many groups.
- 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. For example:
+ 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. For example:
- \code
- / *!
- \class QDir
- \brief The QDir class provides access to directory
- structures and their contents.
+ \code
+ / *!
+ \class QDir
+ \brief The QDir class provides access to directory
+ structures and their contents.
- \ingroup io
- ...
- * /
- \endcode
+ \ingroup io
+ ...
+ * /
+ \endcode
- will ensure that the QDir class is included in the \c io
- group, which means, for example, that QDir will appear on
- the list created by calling the \l {group-command} {\\group} command
- with the \c io argument.
+ This will include the QDir class in the \c io group, which means,
+ for example, that QDir will appear on the list created by calling
+ the \l {group-command} {\\group} command with the \c io argument.
- Note that to list overviews that are related to a given
- group, you must generate the list exlicitly by using the \l
- {generatelist-command} {\\generatelist} command with the \c related
- argument.
+ To list overviews that are related to a certain group, you must
+ generate the list explicitly using the \l {generatelist-command}
+ {\\generatelist} command with the \c related argument.
- See also \l {group-command} {\\group}.
+ See also \l {group-command} {\\group}.
\target inmodule-command
- \section1 \\inmodule
+ \section2 \\inmodule
- The \\inmodule command relates the documented class
- to the module specified by the command's argument.
+ The \\inmodule command relates a class to the module specified by
+ the command's argument.
- For the basic classes in Qt, a class's module is determined
- by its location, i.e. its directory. However, for
- extensions, like ActiveQt and Qt Designer, a class needs to
- be related to a module explicitly.
+ For the basic classes in Qt, a class's module is determined by its
+ location, i.e. its directory. However, for extensions, like
+ ActiveQt and Qt Designer, a class must be related to a module
+ explicitly.
- 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. For example:
+ 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. For example:
- \code
- /*!
- \class QDesignerTaskMenuExtension
- \inmodule QtDesigner
- * /
- \endcode
-
- will ensure that the QDesignerTaskMenuExtension class is
- included in the \c QtDesigner module, which means, for
- example, that the class will appear on the list created by
- calling the \l {generatelist-command} {\\generatelist} command with
- the \c {{classesbymodule QtDesigner}} argument.
+ \code
+ /*!
+ \class QDesignerTaskMenuExtension
+ \inmodule QtDesigner
+ * /
+ \endcode
- See also \l {module-command} {\\module} and \l
- {generatelist-command} {\\generatelist}.
+ This ensures that the QDesignerTaskMenuExtension class is included
+ in the \c QtDesigner module, which means, for example, that the
+ class will appear on the list created by calling the \l
+ {generatelist-command} {\\generatelist} command with the \c
+ {{classesbymodule QtDesigner}} argument.
+ See also \l {module-command} {\\module} and \l
+ {generatelist-command} {\\generatelist}.
*/
/*!
@@ -6369,90 +6366,83 @@
\title Naming Things
- In general a title command considers everything that follows it
- until the first line break as its argument. If the title needs to
- be spanned over several lines, make sure to end each line (except
- the last one) with a backslash.
-
- \target title-command
- \section1 \\title
-
- The \\title command sets the title for a
- documentation page, or allows you to override it.
+ In general, a title command considers everything that follows it
+ until the first line break as its argument. If the title is so
+ long it must span multiple lines, end each line (except the last
+ one) with a backslash.
- For example:
+ \section1 Commands
- \code
- / *!
- \page signalandslots.html
+ \target title-command
+ \section2 \\title
- \title Signals & Slots
+ The \\title command sets the title for a documentation page, or
+ allows you to override it.
- Signals and slots are used for communication between
- objects. The signals and slots mechanism is a central
- feature of Qt and probably the part that differs most
- from the features provided by other frameworks.
+ \code
+ / *!
+ \page signalandslots.html
- ...
- * /
- \endcode
+ \title Signals & Slots
- QDoc renders this as:
+ Signals and slots are used for communication between
+ objects. The signals and slots mechanism is a central
+ feature of Qt and probably the part that differs most
+ from the features provided by other frameworks.
- \quotation
- \raw HTML
- <h1><center>Signal and Slots</center></h1>
- \endraw
+ ...
+ * /
+ \endcode
- Signals and slots are used for communication between
- objects. The signals and slots mechanism is a central
- feature of Qt and probably the part that differs most
- from the features provided by other frameworks.
+ QDoc renders this as:
- ...
- \endquotation
- See also \l {subtitle-command} {\\subtitle}.
+ \quotation
+ \raw HTML
+ <h1><center>Signal and Slots</center></h1>
+ \endraw
+ Signals and slots are used for communication between
+ objects. The signals and slots mechanism is a central
+ feature of Qt and probably the part that differs most
+ from the features provided by other frameworks.
+ ...
+ \endquotation
+ See also \l {subtitle-command} {\\subtitle}.
\target subtitle-command
- \section1 \\subtitle
+ \section2 \\subtitle
- The \\subtitle command sets a subtitle for a
- documentation page.
-
- For example:
-
- \code
- / *!
- \page qtopiacore-overview.html
+ The \\subtitle command sets a subtitle for a documentation page.
- \title Qtopia Core
- \subtitle Qt for Embedded Linux
-
- Qt/Embedded, the embedded Linux port of Qt, is a
- complete and self-contained C++ GUI and platform
- development tool for Linux-based embedded development.
+ \code
+ / *!
+ \page qtopiacore-overview.html
- ...
- * /
- \endcode
+ \title Qtopia Core
+ \subtitle Qt for Embedded Linux
- QDoc renders this as:
+ Qt/Embedded, the embedded Linux port of Qt, is a
+ complete and self-contained C++ GUI and platform
+ development tool for Linux-based embedded development.
+ ...
+ * /
+ \endcode
- \quotation
- \raw HTML
- <h1><center>Qtopia Core</center></h1>
- <h2><center>Qt for Embedded Linux</center></h2>
- \endraw
+ QDoc renders this as:
- Qt/Embedded, the embedded Linux port of Qt, is a
- complete and self-contained C++ GUI and platform
- development tool for Linux-based embedded development.
+ \quotation
+ \raw HTML
+ <h1><center>Qtopia Core</center></h1>
+ <h2><center>Qt for Embedded Linux</center></h2>
+ \endraw
- ...
- \endquotation
+ Qt/Embedded, the embedded Linux port of Qt, is a
+ complete and self-contained C++ GUI and platform
+ development tool for Linux-based embedded development.
+ ...
+ \endquotation
- See also \l {title-command} {\\title}.
+ See also \l {title-command} {\\title}.
*/