From 63569a68d2fd5ca90c4660e632fba2f3f3b37d73 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Sat, 29 Dec 2012 02:09:39 +0800 Subject: Doc: Fix module name format Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtCore -> Qt Core QtDBus -> Qt D-Bus QtDesigner -> Qt Designer QtGui -> Qt GUI QtImageFormats -> Qt Image Formats QtNetwork -> Qt Network QtPrintSupport -> Qt Print Support QtScript -> Qt Script QtSql -> Qt SQL QtSvg -> Qt SVG QtTest -> Qt Test QtWebKit -> Qt WebKit QtWidgets -> Qt Widgets QtXml -> Qt XML QtConcurrent -> Qt Concurrent (partial) QtQuick -> Qt Quick (partial) Also, distinguish between "module" and "library" Change-Id: Icb8aa695ae60b0e45920b0c8fce4dc763a12b0cd Reviewed-by: Jerome Pasion --- src/tools/qdoc/cppcodeparser.cpp | 2 +- src/tools/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 4 ++-- src/tools/qdoc/doc/qdoc-manual.qdoc | 12 ++++++------ src/tools/qdoc/node.cpp | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) (limited to 'src/tools/qdoc') diff --git a/src/tools/qdoc/cppcodeparser.cpp b/src/tools/qdoc/cppcodeparser.cpp index a3d07da4a0..e83147776f 100644 --- a/src/tools/qdoc/cppcodeparser.cpp +++ b/src/tools/qdoc/cppcodeparser.cpp @@ -658,7 +658,7 @@ Node* CppCodeParser::processTopicCommand(const Doc& doc, This function splits the argument into one of those two forms. The three part form is the old form, which - was used before the creation of QtQuick 2 and Qt + was used before the creation of Qt Quick 2 and Qt Components. A is the QML equivalent of a C++ namespace. So this function splits \a arg on "::" and stores the parts in \a type, \a module, \a element, diff --git a/src/tools/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/tools/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index 0c5845a794..d2a2a66beb 100644 --- a/src/tools/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/tools/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -533,7 +533,7 @@ A QML type belongs to a \e module. The module may include all the related types for a platform or contain a certain version of \l{Qt Quick}. For example, the Qt Quick 2 \l{QML Elements} belong - to the QtQuick2 module while there is also a QtQuick1 module for the older + to the Qt Quick 2 module while there is also a Qt Quick 1 module for the older types introduced in Qt 4. QML modules allow grouping QML types. The \l{qmltype-command} @@ -575,7 +575,7 @@ point for readers to find instructional and reference materials that do, such as tutorials, examples and class documentation. An example of an overview might be a product page, such as a top level discussion of - QtQuick, individual modules, design principles, or tools. + Qt Quick, individual modules, design principles, or tools. To signify that a document is an article, you append the article keyword to the \\page command: diff --git a/src/tools/qdoc/doc/qdoc-manual.qdoc b/src/tools/qdoc/doc/qdoc-manual.qdoc index 6da996ecb3..f157f0a2d9 100644 --- a/src/tools/qdoc/doc/qdoc-manual.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual.qdoc @@ -5024,9 +5024,9 @@ / *! \module QtNetwork - \title QtNetwork Module + \title Qt Network Module - \brief The QtNetwork module offers classes that allow + \brief The Qt Network module offers classes that allow you to write TCP/IP clients and servers. The network module provides classes to make network @@ -5042,10 +5042,10 @@ \quotation \raw HTML -

QtNetwork Module

+

Qt Network Module

\endraw - The QtNetwork module offers classes that allow you to + The Qt Network module offers classes that allow you to write TCP/IP clients and servers.\l {module details} {More...} @@ -5083,7 +5083,7 @@

Detailed Description

- The QtNetwork module offers classes that allow you to + The Qt Network module offers classes that allow you to write TCP/IP clients and servers.

@@ -6897,7 +6897,7 @@ \endcode This ensures that the QDesignerTaskMenuExtension class is included - in the \c QtDesigner module, which means, for example, that the + in the Qt Designer 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. diff --git a/src/tools/qdoc/node.cpp b/src/tools/qdoc/node.cpp index f4e45afe74..0fb9ccc97f 100644 --- a/src/tools/qdoc/node.cpp +++ b/src/tools/qdoc/node.cpp @@ -1287,7 +1287,7 @@ void InnerNode::removeChild(Node *child) } /*! - Find the module (QtCore, QtGui, etc.) to which the class belongs. + Find the module (Qt Core, Qt GUI, etc.) to which the class belongs. We do this by obtaining the full path to the header file's location and examine everything between "src/" and the filename. This is semi-dirty because we are assuming a particular directory structure. -- cgit v1.2.3