summaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@nokia.com>2011-02-21 12:18:42 (GMT)
committerMartin Smith <martin.smith@nokia.com>2011-02-21 12:18:42 (GMT)
commit9a811800ed08ac9744f625d57a7dd9227b77a9f8 (patch)
tree59a8731daa638081bcf0a643a11230fda4c02a3c /tools
parentb8c69107e2675b8c2895b8354781c60d3be560df (diff)
downloadQt-9a811800ed08ac9744f625d57a7dd9227b77a9f8.zip
Qt-9a811800ed08ac9744f625d57a7dd9227b77a9f8.tar.gz
Qt-9a811800ed08ac9744f625d57a7dd9227b77a9f8.tar.bz2
qdoc: More updating command descriptions.
Diffstat (limited to 'tools')
-rw-r--r--tools/qdoc3/doc/qdoc-manual.qdoc207
1 files changed, 67 insertions, 140 deletions
diff --git a/tools/qdoc3/doc/qdoc-manual.qdoc b/tools/qdoc3/doc/qdoc-manual.qdoc
index 908eeb9..4ea9fb5 100644
--- a/tools/qdoc3/doc/qdoc-manual.qdoc
+++ b/tools/qdoc3/doc/qdoc-manual.qdoc
@@ -3579,163 +3579,90 @@
* /
\endcode
- \section2 \c legalese
-
- The \c legalese argument provides a complete list of all
- the licenses. The licenses are identified within the
- documentation using the \l {legalese-command} {\\legalese}
- command.
-
- For example:
-
- \quotation
- \raw HTML
- <hr />
- <p>
- Copyright (c) 1989 The Regents of the
- University of California. All rights reserved.
- </p>
-
- <p>
- Redistribution and use in source and binary
- forms are permitted provided that the above
- copyright notice and this paragraph are
- duplicated in all such forms and that any
- documentation, advertising materials, and other
- materials related to such distribution and use
- acknowledge that the software was developed by
- the University of California, Berkeley...
- </p>
-
- <ul>
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qdate.html#weekNumber">QDate::weekNumber()</a>
- </li>
- </ul>
-
- <hr />
- <p>
- Copyright (c) 1991 by AT&amp;T.
- </p>
-
- <p>
- Permission to use, copy, modify, and distribute
- this software for any purpose without fee is
- hereby granted, provided that this entire notice
- is included in all copies of any software which
- is or includes a copy or modification of this
- software and in all copies of the supporting
- documentation for such software...
- </p>
-
- <ul>
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qlocale.html">QLocale</a>
- </li>
- </ul>
- <hr />
- \endraw
- ...
- \endquotation
-
- \section2 \c mainclasses
-
- The \c mainclasses argument provides a complete
- alphabetical list of the main classes. Each class name
- is a link to the class's reference documentation. A
- class is related to the group of main classes by using
- the \l {mainclass-command} {\\mainclass} command.
-
- The list is rendered similarily to the list generated by
- the \l {list example} {\c classes} argument.
+ \section2 \c legalese
- \section2 \c overviews
+ The \c legalese argument tells QDoc to generate a complete list of
+ licenses in the documentation. Each license is identified using
+ the \l {legalese-command} {\\legalese} command. This command is
+ used to generate the \l {licenses.html} {Qt license information}
+ page this way:
- The \c overviews argument provides a complete
- alphabetical overview of the documentation. Each list
- entry is a link to the respective documentation page.
-
- The list includes pages declared using commands like \l
- {page-command} {\\page} and \l {group-command}
- {\\group}. The list omits examples and classes, and only
- lists the first page of documentation that contains two
- or more pages using commands like \l {nextpage-command}
- {\\nextpage}.
-
- For example:
+ \code
+ / *!
+ \page licenses.html
+ \title Other Licenses Used in Qt
+ \ingroup licensing
+ \brief Information about other licenses used for Qt components and third-party code.
+
+ Qt contains some code that is not provided under the
+ \l{GNU General Public License (GPL)},
+ \l{GNU Lesser General Public License (LGPL)} or the
+ \l{Qt Commercial Edition}{Qt Commercial License Agreement}, but rather under
+ specific licenses from the original authors. Some pieces of code were developed
+ by Nokia and others originated from third parties.
+ This page lists the licenses used, names the authors, and links
+ to the places where it is used.
+
+ Nokia gratefully acknowledges these and other contributions
+ to Qt. We recommend that programs that use Qt also acknowledge
+ these contributions, and quote these license statements in an
+ appendix to the documentation.
+
+ See also: \l{Licenses for Fonts Used in Qt for Embedded Linux}
+
+ \generatelist legalese
+ * /
+ \endcode
- \quotation
- \raw HTML
- <ul>
+ \section2 \c mainclasses
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qtalgorithms.html">
- &lt;QtAlgorithms&gt; - Generic Algorithms
- </a>
- </li>
+ The \c mainclasses argument tells QDoc to generate an alphabetical
+ list of the main classes. A class is marked as a main class by
+ including a \l {mainclass-command} {\\mainclass} command in the
+ \\class comment.
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qtglobal.html">
- &lt;QtGlobal&gt; - Global Qt Declarations
- </a>
- </li>
+ \note The Qt documentation no longer includes a main classes page,
+ but you can generate one for your main classes if you want it.
- <li>
- <a href="http://qt.nokia.com/doc/4.0/qaxserver-demo-simple.html">
- A standard ActiveX and the &quot;simple&quot; ActiveQt widget
- </a>
- </li>
+ \section2 \c overviews
- <li>
- <a href="http://qt.nokia.com/doc/4.0/aboutqt.html">
- About Qt
- </a>
- </li>
+ The \c overviews argument is used to tell QDoc to generate a list
+ by concatenating the contents of all the \l {group-command}
+ {\\group} pages. Qt uses it to generate the \l {overviews.html}
+ {overviews} page this way:
- <li>
- <a href="http://qt.nokia.com/doc/4.0/trolltech.html">
- About Trolltech
- </a>
- </li>
+ \code
+ / *!
+ \page overviews.html
- <li>
- <a href="http://qt.nokia.com/doc/4.0/abstractwidgets.html">
- Abstract Widget Classes
- </a>
- </li>
+ \title All Overviews and HOWTOs
- <li>
- <a href="http://qt.nokia.com/doc/4.0/accessibility.html">
- Accessibility Classes
- </a>
- </li>
- ...
- </ul>
- \endraw
- \endquotation
+ \generatelist overviews
+ * /
+ \endcode
- \section2 \c related
+ \section2 \c related
- The \c related argument is used in combination with the
- \l {group-command} {\\group} command to list all the overviews
- related to the given group. Each list entry is a link to
- the respective documentation page.
+ The \c related argument is used in combination with the \l
+ {group-command} {\\group} command to list all the overviews
+ related to the given group. Each list entry is a link to the
+ respective documentation page.
- \section2 \c relatedinline
+ \section2 \c relatedinline
- The \c related argument is used in combination with the
- \l {group-command} {\\group} command to collect all documentation
- related to the given group. The various documentation
- snippets are copied directly into the group page.
+ The \c related argument is used in combination with the \l
+ {group-command} {\\group} command to collect all documentation
+ related to the given group. The various documentation snippets are
+ copied directly into the group page.
- \section2 \c service
+ \section2 \c service
- The \c service argument provides a complete alphabetical
- list of the services. Each service name is a link to the
- service's reference documentation.
+ The \c service argument provides a complete alphabetical list of
+ the services. Each service name is a link to the service's
+ reference documentation.
- A service is identified within the documentation by the
- \l {service-command} {\\service} command.
+ A service is identified within the documentation by the \l
+ {service-command} {\\service} command.
\target if-command