Doc: QDoc Manual: Refer to the tool as 'QDoc' consistently

And add 'QDoc' as a word ignored for auto-linking.

Change-Id: I16a33b8448e8bfa340f4c62149f702fea13d5533
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

9 files changed, 51 insertions, 49 deletions

diff --git a/src/qdoc/doc/config/qdoc.qdocconf b/src/qdoc/doc/config/qdoc.qdocconf
index f29b20aaf..a850d3eb6 100644
--- a/src/qdoc/doc/config/qdoc.qdocconf
+++ b/src/qdoc/doc/config/qdoc.qdocconf
@@ -65,4 +65,6 @@ depends += \
     qtwidgets \
     qtxml
 
+ignorewords += QDoc
+
 navigation.landingpage = "QDoc Manual"
diff --git a/src/qdoc/doc/examples/samples.qdocinc b/src/qdoc/doc/examples/samples.qdocinc
index afe634326..1b83428b2 100644
--- a/src/qdoc/doc/examples/samples.qdocinc
+++ b/src/qdoc/doc/examples/samples.qdocinc
@@ -62,10 +62,10 @@
     \page generic-guide.html
     \title Generic QDoc Guide
     \nextpage Creating QDoc Configuration Files
-    There are three essential materials for generating documentation with qdoc:
+    There are three essential materials for generating documentation with QDoc:
 
     \list
-        \li \c qdoc binary
+        \li \c QDoc binary (\c {qdoc})
         \li \c qdocconf configuration files
         \li \c Documentation in \c C++, \c QML, and \c .qdoc files
     \endlist
diff --git a/src/qdoc/doc/qa-pages.qdoc b/src/qdoc/doc/qa-pages.qdoc
index 1e3ca19f4..47f57eb38 100644
--- a/src/qdoc/doc/qa-pages.qdoc
+++ b/src/qdoc/doc/qa-pages.qdoc
@@ -32,14 +32,14 @@
 
     \title QA Pages
 
-    qdoc can generate some extra HTML pages that can be useful for
-    debugging qdoc documentation. These \e QA pages make it easier for
+    QDoc can generate some extra HTML pages that can be useful for
+    debugging QDoc documentation. These \e QA pages make it easier for
     those who write documentation to find links that either go to the
     wrong targets or don't go anywhere at all.
 
     \section2 Generating the QA Pages
 
-    Add \c {-write-qa-pages} to the command line to tell qdoc to
+    Add \c {-write-qa-pages} to the command line to tell QDoc to
     generate the QA pages. If this option is not provided, the QA
     pages will not be generated, and previolusly generated QA pages
     will be deleted.
@@ -49,7 +49,7 @@
     The main QA page for a module is not linked into the module's
     generated documentation, but it is located in the same output
     directory. To find the top-level QA page for module \e {xxx}, set
-    your browser to the qdoc output directory for module \e {xxx}.
+    your browser to the QDoc output directory for module \e {xxx}.
     Several files whose names begin with \e {aaa} appear at the top of
     the list. These are the QA pages for module \e{xxx}. The file
     names begin with \e {aaa} to ensure that they are easy to find at
@@ -83,11 +83,11 @@
     QtCore to QtQuick.  The first column of each table entry contains
     a link to some link in QtCore. The link text as it appears in
     QtCore is shown. The second and third columns contain the source
-    file name and line number for where qdoc saw the link in a qdoc
+    file name and line number for where QDoc saw the link in a qdoc
     comment.
 
     \note The line number will normally refer to the first line of the
-    comment where qdoc saw the link.
+    comment where QDoc saw the link.
 
     Clicking on a link in the table takes you to that link in the
     documentation. There the link will be marked with three red
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
index c964493bc..abd2661d8 100644
--- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
+++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
@@ -37,7 +37,7 @@
     \l{writing-markup}{mark up} to enhance the layout and formatting of the
     final output.
 
-    There are three essential materials for generating documentation with qdoc:
+    There are three essential materials for generating documentation with QDoc:
     \list
         \li \c QDoc binary
         \li \c qdocconf configuration files
@@ -95,12 +95,12 @@
     can style the documentation in DITA at a later time. DITA XML is therefore
     more flexible in allowing different styles to apply to the same information.
 
-    To run qdoc, the project configuration file is supplied as an argument.
+    To run QDoc, the project configuration file is supplied as an argument.
     \code
     qdoc project.qdocconf
     \endcode
 
-    The project configuration contains information that qdoc uses to create the
+    The project configuration contains information that QDoc uses to create the
     documentation.
 
     \section2 Project Information
@@ -267,7 +267,7 @@
     comment; the comment itself and anything after it, until a newline,
     is omitted from the generated output.
 
-    QDoc will parse C++ and QML files to look for qdoc comments. To explicitly
+    QDoc will parse C++ and QML files to look for QDoc comments. To explicitly
     omit a certain file type, omit it from the
     \l{Input and Output Directories}{configuration} file.
 
@@ -280,7 +280,7 @@
 
     \target writing-topic-commands
     \section2 QDoc Topics
-    Each qdoc comment must have a \e topic type. A topic distinguishes it from
+    Each QDoc comment must have a \e topic type. A topic distinguishes it from
     other topics. To specify a topic type, use one of the several
     \l{Topic Commands}{topic commands}.
 
diff --git a/src/qdoc/doc/qdoc-manual-intro.qdoc b/src/qdoc/doc/qdoc-manual-intro.qdoc
index a943863a6..525445b4f 100644
--- a/src/qdoc/doc/qdoc-manual-intro.qdoc
+++ b/src/qdoc/doc/qdoc-manual-intro.qdoc
@@ -88,7 +88,7 @@
 
     \section1 Running QDoc
 
-    The name of the QDoc program is \c {qdoc}. To run qdoc from the
+    The name of the QDoc program is \c {qdoc}. To run QDoc from the
     command line, give it the name of a configuration file:
 
     \quotation
@@ -284,7 +284,7 @@
 
     For each QDoc comment it finds, it searches the master tree for
     the item where the documentation belongs. Then it interprets the
-    qdoc commands in the comment and stores the interpreted commands
+    QDoc commands in the comment and stores the interpreted commands
     and the comment text in the tree node for the item.
 
     Finally, QDoc traverses the master tree. For each node, if the
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
index 6fc16c9e1..69d10fb9a 100644
--- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -206,9 +206,9 @@
     text (which may include other QDoc commands) to which special
     formatting attributes should be applied.
 
-    An argument must be provided in curly braces, as in the qdoc
+    An argument must be provided in curly braces, as in the QDoc
     comment shown below. The argument is not interpreted but is used
-    as attribute(s) of the tag that is output by qdoc.
+    as attribute(s) of the tag that is output by QDoc.
 
     For example, we might want to render an inline image so that it
     floats to the right of the current block of text:
@@ -222,7 +222,7 @@
       * /
     \endcode
 
-    If qdoc is generating HTML, it will translate these commands to:
+    If QDoc is generating HTML, it will translate these commands to:
 
     \code
       <div class="float-right"><p><img src="images/qml-column.png" /></p></div>
@@ -1699,7 +1699,7 @@
     ...
     \endcode
 
-    By default, qdoc looks for \c{//!} as a code snippet marker.
+    By default, QDoc looks for \c{//!} as a code snippet marker.
     For \c{.pro}, \c{.py}, \c{.cmake}, and \c{CMakeLists.txt}
     files, \c {#!} is detected. Finally, \c{<!--} is accepted in
     \c{.html}, \c{.qrc}, \c{.ui}, \c{.xml}, \c{.dita}, and \c{.xq} files.
@@ -1805,7 +1805,7 @@
 
     \li \c {\l QWidget::removeAction(QAction* action)} - The signature
     of a function with parameters. If an exact match is not found, the
-    link is not satisfied and qdoc reports a \e {Can't link to...} error.
+    link is not satisfied and QDoc reports a \e {Can't link to...} error.
 
     \li \c {\l <QtGlobal>} - The subject of a \l {headerfile-command}
     {\\headerfile} command.
@@ -1850,7 +1850,7 @@
     \section2 Fixing Ambiguous Links
 
     Because of the modularization of Qt beginning with Qt 5.0, The
-    possibility that qdoc will have to deal with ambiguous links has
+    possibility that QDoc will have to deal with ambiguous links has
     increased. An ambiguous link is one that has a matching target in
     more than one Qt module, e.g. the same section title can appear in
     more than one Qt module, or the name of a C++ class in one module
@@ -1859,7 +1859,7 @@
     namespace in QtCore and a QML type in QtQml.
 
     Suppose we want to link to the \l {Qt} {Qt C++ namespace}.  At the
-    time qdoc generated this HTML page, that link was correct.  Does
+    time QDoc generated this HTML page, that link was correct.  Does
     it still go to the C++ namespace? Qdoc generated that link from
     this link command:
 
@@ -1868,22 +1868,22 @@
     \endlist
 
     Now suppose we want to link to the \l [QML] {Qt} {Qt QML type}.
-    At the time qdoc generated this HTML page, that link was also
+    At the time QDoc generated this HTML page, that link was also
     correct, but we had to use this link command:
 
     \list
         \li \c {\l [QML] {Qt} {Qt QML type}}
     \endlist
 
-    The \e {QML} in \e {square brackets} tells qdoc to accept a
+    The \e {QML} in \e {square brackets} tells QDoc to accept a
     matching target only if the traget is on a QML page. Qdoc actually
     finds the C++ namespace target first, but since that target is on
-    a C++ page, qdoc ignores it and keeps looking until it finds the
+    a C++ page, QDoc ignores it and keeps looking until it finds the
     same target on a QML page.
 
     Without the guidance in the \e{\\l command} in the optional \e
-    {square bracket} argument, qdoc links to the first matching target
-    it finds. qdoc can't warn that the link was ambiguous in such
+    {square bracket} argument, QDoc links to the first matching target
+    it finds. QDoc can't warn that the link was ambiguous in such
     cases because it doesn't know that another matching target exists.
 
     \section2 What arguments can appear in square brackets?
@@ -1895,13 +1895,13 @@
 
     The \e {square bracket} argument is only allowed in the \c {\l
     (link)} command. The example above shows how \c QML is used as the
-    \e {square brackets} argument to force qdoc to match a QML target.
+    \e {square brackets} argument to force QDoc to match a QML target.
     Most often, this will be a QML type, but it can also be a QML
     member function of property.
 
-    In the example, qdoc didn't need a \e {square bracket} argument to
+    In the example, QDoc didn't need a \e {square bracket} argument to
     find the Qt C++ namespace page, because that one was the first
-    matching target qdoc found anyway. However, to force qdoc to find
+    matching target QDoc found anyway. However, to force QDoc to find
     a C++ target when a matching QML target gets in the way, \c CPP
     can be used as the \e {square bracket} argument. For example:
 
@@ -1909,11 +1909,11 @@
         \li \c {\l [CPP] {Qt} {Qt C++ namespace}}
     \endlist
 
-    ...will force qdoc to ignore the Qt QML type and continue
+    ...will force QDoc to ignore the Qt QML type and continue
     searching until it matches the Qt C++ namespace.
 
     If the link target is neither a C++ nor a QML entity, \c {DOC} can
-    be used as the \e {square bracket} argument to prevent qdoc from
+    be used as the \e {square bracket} argument to prevent QDoc from
     matching either of those. At this writing, there were no cases of
     ambiguous links where using \c {DOC} was required.
 
@@ -1928,7 +1928,7 @@
     \endlist
 
     When a module name is used as the \e {square bracket} argument,
-    qdoc will search for link the target in that module only. This
+    QDoc will search for link the target in that module only. This
     makes searching for link targets more efficient.
 
     Finally, the module name and entity type arguments can be
@@ -2710,7 +2710,7 @@
                \li Tutorial and Examples
            \endlist
 
-    \warning There appears to be a bug in qdoc here. If you include
+    \warning There appears to be a bug in QDoc here. If you include
     any of the argument types, you get a numeric list. We're looking
     into it.
 
@@ -3796,12 +3796,12 @@
 
     The command must stand on its own line. See \l {Qt Sensors QML Types} for
     an example. The page is generated from \c {qtsensors5.qdoc}. There you will
-    find a qdoc comment containing the \c{\qmlmodule} command for the QtSensors
-    module. The same qdoc comment contains two \c {\annotated-list} commands to
+    find a QDoc comment containing the \c{\qmlmodule} command for the QtSensors
+    module. The same QDoc comment contains two \c {\annotated-list} commands to
     list the QML types in two separate groups. The QML types have been divided
     into these two groups because it makes more sense to list them this way than
     it does to list them in a single alphabetical list. At the bottom of the
-    comment, \c {\noautolist} has been used to tell qdoc not to generate the
+    comment, \c {\noautolist} has been used to tell QDoc not to generate the
     automatic annotated list.
 
     This command was introduced in QDoc 5.6.
@@ -3916,7 +3916,7 @@
                \endraw
            \endquotation
 
-    \note But you can achieve the exact same thing using qdoc
+    \note But you can achieve the exact same thing using QDoc
     commands. In this case, all you have to do is include the color
     styles in your style.css file. Then you can write:
 
diff --git a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
index 5f43a1d41..ef92cc99e 100644
--- a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
+++ b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc
@@ -390,7 +390,7 @@
     \section1 examples.fileextensions
 
     The \c examples.fileextensions variable specifies the file
-    extensions that qdoc will look for when collecting example files
+    extensions that QDoc will look for when collecting example files
     for display in the documentation.
 
     The default extensions are *.cpp, *.h, *.js, *.xq, *.svg, *.xml
@@ -409,7 +409,7 @@
     \section1 excludedirs
 
     The \c excludedirs variable is for listing directories that should \e{not}
-    be processed by qdoc, even if the same directories are included by the
+    be processed by QDoc, even if the same directories are included by the
     \l {sourcedirs-variable} {sourcedirs} or \l {headerdirs-variable} {headerdirs}
     variables.
 
@@ -422,7 +422,7 @@
 
     When executed, QDoc will exclude the listed directories from
     further consideration. Files in these directories will not be
-    read by qdoc.
+    read by QDoc.
 
     See also \l {excludefiles-variable} {excludefiles}.
 
@@ -430,7 +430,7 @@
     \section1 excludefiles
 
     The \c excludefiles variable allows you to specify individual files
-    that should \e{not} be processed by qdoc.
+    that should \e{not} be processed by QDoc.
 
     \badcode
     excludefiles += $QT_CORE_SOURCES/../../src/widgets/kernel/qwidget.h \
@@ -908,7 +908,7 @@
     \section1 naturallanguage
 
     The \c naturallanguage variable specifies the natural language
-    used for the documentation generated by qdoc.
+    used for the documentation generated by QDoc.
 
     \badcode
         naturallanguage = zh-Hans
@@ -917,7 +917,7 @@
     By default, the natural language is \c en for compatibility with
     legacy documentation.
 
-    qdoc will add the natural language information to the HTML it
+    QDoc will add the natural language information to the HTML it
     generates, using the \c lang and \c xml:lang attributes.
 
     See also \l {sourceencoding-variable} {sourceencoding},
@@ -1011,7 +1011,7 @@
     \section1 outputencoding
 
     The \c outputencoding variable specifies the encoding used for the
-    documentation generated by qdoc.
+    documentation generated by QDoc.
 
     \badcode
         outputencoding = UTF-8
@@ -1023,7 +1023,7 @@
     languages, this is not sufficient and an encoding such as UTF-8 is
     required.
 
-    qdoc will encode HTML using this encoding and generate the correct
+    QDoc will encode HTML using this encoding and generate the correct
     declarations to indicate to browsers which encoding is being
     used. The \l naturallanguage configuration variable should also be
     specified to provide browsers with a complete set of character
@@ -1156,7 +1156,7 @@
     particularly non-European languages, this is not sufficient and an
     encoding such as UTF-8 is required.
 
-    Although qdoc will use the encoding to read source and
+    Although QDoc will use the encoding to read source and
     documentation files, limitations of C++ compilers may prevent you
     from using non-ASCII characters in source code comments. In cases
     like these, it is possible to write API documentation completely
diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
index e7405e442..09eddad00 100644
--- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
@@ -942,7 +942,7 @@
 
     \li api - This is the type of page used for C++ class references and
     QML type references. You should never use this one for the pages
-    you write, because this one is reserved for qdoc.
+    you write, because this one is reserved for QDoc.
 
     \endlist
 
diff --git a/src/qdoc/doc/qtgui-qdocconf.qdoc b/src/qdoc/doc/qtgui-qdocconf.qdoc
index 4161c2917..89c46ff94 100644
--- a/src/qdoc/doc/qtgui-qdocconf.qdoc
+++ b/src/qdoc/doc/qtgui-qdocconf.qdoc
@@ -273,7 +273,7 @@ Add the specified directories to the list of directories containing the \e .cpp
 \endcode
 
 The \c excludedirs variable is for listing directories that should not be processed
-by qdoc, even if the same directories are included by the \c sourcedirs or \c headerdirs
+by QDoc, even if the same directories are included by the \c sourcedirs or \c headerdirs
 variables.
 
 When executed, QDoc will ignore the directories listed.