summaryrefslogtreecommitdiffstats
path: root/tools/qdoc3/doc
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-02-22 13:44:52 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-02-22 13:44:52 (GMT)
commit276ae3c231a80b5cf64ae431e9386ac63d48a278 (patch)
tree5cf082ced2797e8b265ee53ee96c8d0365a79292 /tools/qdoc3/doc
parent9c93c18d8b5eb2df5fa8feb1bc4d076071501e68 (diff)
downloadQt-276ae3c231a80b5cf64ae431e9386ac63d48a278.zip
Qt-276ae3c231a80b5cf64ae431e9386ac63d48a278.tar.gz
Qt-276ae3c231a80b5cf64ae431e9386ac63d48a278.tar.bz2
qdoc: More updating command descriptions.
Diffstat (limited to 'tools/qdoc3/doc')
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc191
1 files changed, 80 insertions, 111 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index db2a976..5945aea 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -4802,43 +4802,36 @@
\target module-command
\section1 \\module
- The \\module creates a separate page that lists the
- classes belonging to the module specified by the command's
- argument.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- A class can be related to a module using the \l
- {inmodule-command} {\\inmodule} command.
-
- The \\module command is typically followed by the \l
- {title-command} {\\title} and \l {brief-command} {\\brief}
- commands. Each class is listed with a link to the class
- reference page and a brief description based on the
- classes' \l {brief-command} {\\brief} texts.
-
- For example:
+ The \\module creates a page that lists the classes belonging to
+ the module specified by the command's argument. A class included
+ in the module by including the \l {inmodule-command} {\\inmodule}
+ command in the \\class comment.
+
+ The \\module command is typically followed by a \l {title-command}
+ {\\title} and a \l {brief-command} {\\brief} command. Each class
+ is listed as a link to the class reference page followed by the
+ text from the class's \l {brief-command} {\\brief} command. For
+ example:
- \code
- / *!
- \module QtNetwork
+ \code
+ / *!
+ \module QtNetwork
- \title QtNetwork Module
+ \title QtNetwork Module
- \brief The QtNetwork module offers classes that allow
- you to write TCP/IP clients and servers.
+ \brief The QtNetwork module offers classes that allow
+ you to write TCP/IP clients and servers.
- The network module provides classes to make network
- programming easier and portable. It offers both
- high-level classes such as QHttp and QFtp that
- implement specific application-level protocols, and
- lower-level classes such as QTcpSocket, QTcpServer, and
- QUdpSocket.
- * /
- \endcode
+ The network module provides classes to make network
+ programming easier and portable. It offers both
+ high-level classes such as QHttp and QFtp that
+ implement specific application-level protocols, and
+ lower-level classes such as QTcpSocket, QTcpServer, and
+ QUdpSocket.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this in \c {qtnetwork.html} something like this:
\quotation
\raw HTML
@@ -4901,37 +4894,26 @@
\endquotation
- in qtnetwork.html.
-
- See also \l {inmodule-command} {\\inmodule}
-
+ See also \l {inmodule-command} {\\inmodule}
\target namespace-command
\section1 \\namespace
- The \\namespace command allows you to document a C++ namespace.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
+ The \\namespace command is for documenting the contents of the C++
+ namespace named as its argument. The documentation outline QDoc
+ generates for a namespace is similar to the outline it generates
+ for a C++ class. For example:
- QDoc will generate the same additional links and
- documentation for all the members of the namespace as it
- does for \l {framework} {classes}. The documentation for
- the specified namespace is put in <lower-case>\e
- {namespace}.html.
-
- For example:
-
- \code
- / *!
- \namespace Qt
+ \code
+ / *!
+ \namespace Qt
- \brief The Qt namespace contains miscellaneous
- identifiers used throughout the Qt library.
- * /
- \endcode
+ \brief The Qt namespace contains miscellaneous
+ identifiers used throughout the Qt library.
+ * /
+ \endcode
- QDoc renders this as:
+ QDoc renders this in \c{qt.html} something like this:
\quotation
\raw HTML
@@ -4968,19 +4950,13 @@
...
\endquotation
- in qt.html.
-
-
\target page-command
\section1 \\page
- The \\page command allows you to create a stand-alone documentation page.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- The page's title can be set using the \l {title-command} {\\title}
- command. For example:
+ The \\page command is for creating a stand-alone documentation
+ page. The argument is the name of the file where QDoc should
+ store the page. The page title is set using the \l {title-command}
+ {\\title} command. For example:
\code
/ *!
@@ -5005,63 +4981,56 @@
* /
\endcode
- will be rendered in its own HTML file: \l{About Qt}.
-
+ QDoc renders this page in \c {aboutqt.html}.
\target externalpage-command
\section1 \\externalpage
- The \\externalpage command gives a title to an external URL.
-
- The command follows \l {topic argument} {the general
- topic command convention} for the argument.
-
- For example:
-
- \code
- / *!
- \externalpage http://www.trolltech.com/products/embedded/index.html
- \title Qtopia Core
- * /
- \endcode
+ The \\externalpage command assigns a title to an external URL.
+ For example:
- The QDoc comment above allows you to link to the Qtopia
- Core webpage by simply linking to the given title. For
- example:
+ \code
+ / *!
+ \externalpage http://doc.trolltech.com/4.3/qtopiacore.html
+ \title Qtopia Core
+ * /
+ \endcode
- \code
- / *!
- The broad scope of the \l {Qtopia Core} API enables it to
- be used across a wide variety of development projects.
- * /
- \endcode
+ This allows you to include a link to the external page in your
+ documentation this way:
- QDoc renders this as:
+ \code
+ / *!
+ The broad scope of the \l {Qtopia Core} API enables it to
+ be used across a wide variety of development projects.
+ * /
+ \endcode
- \quotation
- The broad scope of the \l
- {http://www.trolltech.com/products/embedded/index.html} {Qtopia
- Core} API enables it to be used across a wide variety
- of development projects.
- \endquotation
+ QDoc renders this as:
- To achieve the same result without using the
- \\externalpage command, you would have to hard code the
- adress into your documentation:
+ \quotation
+ The broad scope of the \l
+ {http://doc.trolltech.com/4.3/qtopiacore.html} {Qtopia
+ Core} API enables it to be used across a wide variety
+ of development projects.
+ \endquotation
- \code
- / *!
- The broad scope of the \l
- {http://www.trolltech.com/products/embedded/index.html} {Qtopia
- Core} API enables it to be used across a wide variety
- of development projects.
- * /
- \endcode
+ To achieve the same result without using the \\externalpage
+ command, you would have to hard code the adress into your
+ documentation:
- The \\externalpage command makes it easier to maintain the
- documentation. If the adress changes, you only need to change the
- argument of the \\externalpage command.
+ \code
+ / *!
+ The broad scope of the \l
+ {http://doc.trolltech.com/4.3/qtopiacore.html} {Qtopia
+ Core} API enables it to be used across a wide variety
+ of development projects.
+ * /
+ \endcode
+ The \\externalpage command makes it easier to maintain the
+ documentation. If the adress changes, you only need to change the
+ argument of the \\externalpage command.
\target property-command
\section1 \\property