diff options
Diffstat (limited to 'src/tools/qdoc/doc')
-rw-r--r-- | src/tools/qdoc/doc/config/qdoc.qdocconf | 1 | ||||
-rw-r--r-- | src/tools/qdoc/doc/examples/main.cpp | 30 | ||||
-rw-r--r-- | src/tools/qdoc/doc/examples/mainwindow.cpp | 30 | ||||
-rw-r--r-- | src/tools/qdoc/doc/files/qtgui.qdocconf | 1 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-guide/qtwritingstyle-cpp.qdoc | 2 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-DITA.qdoc | 6 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-intro.qdoc | 2 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc | 28 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc | 13 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc | 4 |
10 files changed, 62 insertions, 55 deletions
diff --git a/src/tools/qdoc/doc/config/qdoc.qdocconf b/src/tools/qdoc/doc/config/qdoc.qdocconf index 0f4ad07711..9d841e9b64 100644 --- a/src/tools/qdoc/doc/config/qdoc.qdocconf +++ b/src/tools/qdoc/doc/config/qdoc.qdocconf @@ -2,7 +2,6 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) project = QDoc description = QDoc Manual -url = http://qt-project.org/doc/qt-$QT_VER version = $QT_VERSION sourcedirs = .. diff --git a/src/tools/qdoc/doc/examples/main.cpp b/src/tools/qdoc/doc/examples/main.cpp index 62c0576931..4a594feb44 100644 --- a/src/tools/qdoc/doc/examples/main.cpp +++ b/src/tools/qdoc/doc/examples/main.cpp @@ -1,40 +1,32 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the tools applications of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ +** $QT_BEGIN_LICENSE:LGPL21$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information ** use the contact form at http://qt.digia.com/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Digia gives you certain additional -** rights. These rights are described in the Digia Qt LGPL Exception +** rights. These rights are described in the Digia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3.0 as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU General Public License version 3.0 requirements will be -** met: http://www.gnu.org/copyleft/gpl.html. -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/src/tools/qdoc/doc/examples/mainwindow.cpp b/src/tools/qdoc/doc/examples/mainwindow.cpp index bc7b415d67..9a6cdd8a97 100644 --- a/src/tools/qdoc/doc/examples/mainwindow.cpp +++ b/src/tools/qdoc/doc/examples/mainwindow.cpp @@ -1,40 +1,32 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the tools applications of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ +** $QT_BEGIN_LICENSE:LGPL21$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information ** use the contact form at http://qt.digia.com/contact-us. ** ** GNU Lesser General Public License Usage ** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** In addition, as a special exception, Digia gives you certain additional -** rights. These rights are described in the Digia Qt LGPL Exception +** rights. These rights are described in the Digia Qt LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3.0 as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU General Public License version 3.0 requirements will be -** met: http://www.gnu.org/copyleft/gpl.html. -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/src/tools/qdoc/doc/files/qtgui.qdocconf b/src/tools/qdoc/doc/files/qtgui.qdocconf index 7f80808bfc..855ed538c2 100644 --- a/src/tools/qdoc/doc/files/qtgui.qdocconf +++ b/src/tools/qdoc/doc/files/qtgui.qdocconf @@ -2,7 +2,6 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) project = QtGui description = Qt GUI Reference Documentation -url = http://qt-project.org/doc/qt-$QT_VER version = $QT_VERSION examplesinstallpath = gui diff --git a/src/tools/qdoc/doc/qdoc-guide/qtwritingstyle-cpp.qdoc b/src/tools/qdoc/doc/qdoc-guide/qtwritingstyle-cpp.qdoc index 304a736860..291363a22d 100644 --- a/src/tools/qdoc/doc/qdoc-guide/qtwritingstyle-cpp.qdoc +++ b/src/tools/qdoc/doc/qdoc-guide/qtwritingstyle-cpp.qdoc @@ -166,7 +166,7 @@ the notifier. \snippet examples/cpp.qdoc.sample overloaded notifier -\section1 Enums, Namespaces, and other Types +\section1 Enums, Namespaces, and Other Types Enums, namespaces, and macros have a \l{writing-topic-commands}{topic command} for their documentation: \list diff --git a/src/tools/qdoc/doc/qdoc-manual-DITA.qdoc b/src/tools/qdoc/doc/qdoc-manual-DITA.qdoc index 070bad336f..4e4bea7556 100644 --- a/src/tools/qdoc/doc/qdoc-manual-DITA.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-DITA.qdoc @@ -39,7 +39,7 @@ documentation build process is still under consideration. This section will be updated as the decisions are made. - \section1 What is a DITA map? + \section1 What is a DITA Map? A complete description of DITA can be found at the \l{http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita} @@ -107,7 +107,7 @@ \mapref {Creator Manual} {creator-manual.ditamap} \endmapref \endcode - \section1 An example ditamap page + \section1 An Example Ditamap Page The following example uses the three qdoc ditamap commands described above. @@ -131,7 +131,7 @@ \endtopicref \endcode - \section1 The resulting ditamap file + \section1 The Resulting Ditamap File This is the \e{.ditamap} file you get when you input the qdoc ditamap page shown above. Note that you can write ditamap files diff --git a/src/tools/qdoc/doc/qdoc-manual-intro.qdoc b/src/tools/qdoc/doc/qdoc-manual-intro.qdoc index f681c0a574..636cd6980e 100644 --- a/src/tools/qdoc/doc/qdoc-manual-intro.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-intro.qdoc @@ -107,7 +107,7 @@ See \l{The QDoc Configuration File} for instructions on how to set up a QDoc configuration file. - \section1 How QDoc works + \section1 How QDoc Works QDoc begins by reading the configuration file you specified on the command line. It stores all the variables from the configuration diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc index fe43938968..c04cdeca2b 100644 --- a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -2543,6 +2543,13 @@ file or namespace documentation. See the \l {enum-command} {\\enum} documentation for an example. + \note Since Qt 5.4, \\value command can also be used outside the + \l {enum-command} {\\enum} topic. In this case, QDoc renders a + two-column table listing the constant name (taken as-is from the + first argument) and its description. This can be used, for + example, in \l {qmlproperty-command}{\\qmlproperty} topic for + documenting acceptable values for a QML enumeration property. + See also \l {enum-command} {\\enum} and \l {omitvalue-command} {\\omitvalue}. \target omitvalue-command @@ -3251,9 +3258,9 @@ \target generatelist-command \section1 \\generatelist - The \\generatelist command expands to a list of various - documentation or links to documentation. Below is an example from - the Qt Reference Documentation: + The \\generatelist command expands to a list of links to the + documentation entities in a group. Below is an example from the Qt + Reference Documentation: \code / *! @@ -3263,7 +3270,7 @@ For a shorter list that only includes the most frequently used classes, see \l{Qt's Main Classes}. - \generatelist classes + \generatelist classes Q * / \endcode @@ -3295,10 +3302,17 @@ of the class comment's \l {brief-command} {\\brief} command. \target list example - \section2 \c classes + \section2 \c {classes <prefix>} The \c classes argument provides a complete alphabetical list of - the classes. Each class name is a link to the class's reference + the classes. The second argument, \c{<prefix>}, is the common + prefix for the class names. The class names will be sorted on the + character that follows the common prefix. e.g. The common prefix + for the Qt classes is \c Q. The common prefix argument is + optional. If no common prefix is provided, the class names will + be sorted on their first character. + + Each class name becomes a link to the class's reference documentation. This command is used to generate the \e {All Classes} page this way: @@ -3315,7 +3329,7 @@ Classes}. For classes that have been deprecated, see the \l{Obsolete Classes} list. - \generatelist classes + \generatelist classes Q * / \endcode diff --git a/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc index 913f8fcc00..093f9cc2c6 100644 --- a/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the documentation of the Qt Toolkit. @@ -1126,7 +1126,7 @@ erroneous documentation due to non-standard C++ constructs. \target Cpp.ignoredirectives-variable - \section1 Cpp.ignoredirectives + \section1 Cpp.ignoredirectives The \c Cpp.ignoredirectives variable makes QDoc ignore the specified non-standard constructs, within C++ source code. @@ -1177,7 +1177,7 @@ See also \l Cpp.ignoretokens. \target Cpp.ignoretokens-variable - \section1 Cpp.ignoretokens + \section1 Cpp.ignoretokens The \c Cpp.ignoretokens variable makes QDoc ignore the specified non-standard constructs, within C++ source code. @@ -1331,6 +1331,13 @@ \l qtgui.qdocconf file, and it will copy those specified to the output directory alongside the HTML pages. + \target HTML.tocdepth + \section1 HTML.tocdepth + + The HTML.tocdepth variable defines how many document sections are printed in + the table of contents. Setting tocdepth to \c 0 disables the table of + contents while not setting the variable prints all document sections. + */ /*! diff --git a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc index b9667b7758..b50a343a22 100644 --- a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -1315,6 +1315,10 @@ \l {http://qt-project.org/doc/qt-4.7/qml-translate.html} {Translate} element. + If the QML property is of enumeration type, or it holds a bit-wise + combination of flags, the \l{value-command}{\\value} command can + be used to document the acceptable values. + \target qmlsignal-command \section1 \\qmlsignal |