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 --- examples/gui/doc/src/rasterwindow.qdoc | 2 +- examples/sql/doc/src/masterdetail.qdoc | 2 +- examples/sql/masterdetail/mainwindow.cpp | 4 ++-- examples/widgets/doc/src/application.qdoc | 4 ++-- examples/widgets/doc/src/dockwidgets.qdoc | 4 ++-- examples/widgets/doc/src/styles.qdoc | 2 +- examples/xml/htmlinfo/main.cpp | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) (limited to 'examples') diff --git a/examples/gui/doc/src/rasterwindow.qdoc b/examples/gui/doc/src/rasterwindow.qdoc index 152a60e180..61843f2248 100644 --- a/examples/gui/doc/src/rasterwindow.qdoc +++ b/examples/gui/doc/src/rasterwindow.qdoc @@ -54,7 +54,7 @@ \snippet rasterwindow/rasterwindow.h 1 - We first start by including the QtGui headers. This means we + We first start by including the \c header. This means we can use all classes in the Qt GUI module. Classes can also be included individually if that is preferred. diff --git a/examples/sql/doc/src/masterdetail.qdoc b/examples/sql/doc/src/masterdetail.qdoc index da57a16d35..abf2624844 100644 --- a/examples/sql/doc/src/masterdetail.qdoc +++ b/examples/sql/doc/src/masterdetail.qdoc @@ -38,7 +38,7 @@ The example also shows how to add as well as remove data from both the database and the associated XML file using the API provided by - the QtSql and QtXml modules, respectively. + the Qt SQL and Qt XML modules, respectively. \image masterdetail-example.png */ diff --git a/examples/sql/masterdetail/mainwindow.cpp b/examples/sql/masterdetail/mainwindow.cpp index ce45ddb9e6..f3bd194c31 100644 --- a/examples/sql/masterdetail/mainwindow.cpp +++ b/examples/sql/masterdetail/mainwindow.cpp @@ -424,6 +424,6 @@ void MainWindow::about() "are kept in a database, while each album's tracks are stored " "in an XML file.

The example also shows how to add as " "well as remove data from both the database and the " - "associated XML file using the API provided by the QtSql and " - "QtXml modules, respectively.

")); + "associated XML file using the API provided by the Qt SQL and " + "Qt XML modules, respectively.

")); } diff --git a/examples/widgets/doc/src/application.qdoc b/examples/widgets/doc/src/application.qdoc index 146852001a..0d244bce00 100644 --- a/examples/widgets/doc/src/application.qdoc +++ b/examples/widgets/doc/src/application.qdoc @@ -76,8 +76,8 @@ \snippet mainwindows/application/mainwindow.cpp 0 We start by including \c , a header file that contains the - definition of all classes in the \l QtCore and \l QtGui - libraries. This saves us from the trouble of having to include + definition of all classes in the Qt Core and Qt GUI + modules. This saves us from the trouble of having to include every class individually. We also include \c mainwindow.h. You might wonder why we don't include \c in \c diff --git a/examples/widgets/doc/src/dockwidgets.qdoc b/examples/widgets/doc/src/dockwidgets.qdoc index 6a6e9da417..7f08572a30 100644 --- a/examples/widgets/doc/src/dockwidgets.qdoc +++ b/examples/widgets/doc/src/dockwidgets.qdoc @@ -56,8 +56,8 @@ \snippet mainwindows/dockwidgets/mainwindow.cpp 0 We start by including \c , a header file that contains the - definition of all classes in the \l QtCore and \l QtGui - libraries. This saves us from having to include + definition of all classes in the Qt Core and Qt GUI + modules. This saves us from having to include every class individually and is especially convenient if we add new widgets. We also include \c mainwindow.h. diff --git a/examples/widgets/doc/src/styles.qdoc b/examples/widgets/doc/src/styles.qdoc index 3ec745b3cc..53c0665b3d 100644 --- a/examples/widgets/doc/src/styles.qdoc +++ b/examples/widgets/doc/src/styles.qdoc @@ -37,7 +37,7 @@ A style in Qt is a subclass of QStyle or of one of its subclasses. Styles perform drawing on behalf of widgets. Qt provides a whole range of predefined styles, either built into - the \l QtWidgets library or found in plugins. Styles are usually + the Qt Widgets module or found in plugins. Styles are usually customized by subclassing QProxyStyle and reimplementing a few virtual functions. While QProxyStyle provides a transparent way to customize either a specific style or the appropriate platform's diff --git a/examples/xml/htmlinfo/main.cpp b/examples/xml/htmlinfo/main.cpp index be40e670bf..7179e8221b 100644 --- a/examples/xml/htmlinfo/main.cpp +++ b/examples/xml/htmlinfo/main.cpp @@ -94,7 +94,7 @@ void parseHtmlFile(QTextStream &out, const QString &fileName) { int main(int argc, char **argv) { - // initialize QtCore application + // initialize Qt Core application QCoreApplication app(argc, argv); // get a list of all html files in the current directory -- cgit v1.2.3 From 9ccd00703dabd9cc34052aab23ee95a0d805c00c Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Mon, 14 Jan 2013 16:02:30 +0100 Subject: Doc: Widgets/Tools examples: fix group and missing images Adds two images missing from Completer example documentation and fixes typos in \ingroup parameter. Change-Id: I2a9c1a22c65145dba37b182a82c19f4f0e424ca7 Reviewed-by: Jerome Pasion --- .../widgets/doc/images/completer-example-dirmodel.png | Bin 0 -> 14389 bytes .../widgets/doc/images/completer-example-qdirmodel.png | Bin 0 -> 13896 bytes examples/widgets/doc/src/completer.qdoc | 2 +- examples/widgets/doc/src/regexp.qdoc | 2 +- 4 files changed, 2 insertions(+), 2 deletions(-) create mode 100644 examples/widgets/doc/images/completer-example-dirmodel.png create mode 100644 examples/widgets/doc/images/completer-example-qdirmodel.png (limited to 'examples') diff --git a/examples/widgets/doc/images/completer-example-dirmodel.png b/examples/widgets/doc/images/completer-example-dirmodel.png new file mode 100644 index 0000000000..94b75b0795 Binary files /dev/null and b/examples/widgets/doc/images/completer-example-dirmodel.png differ diff --git a/examples/widgets/doc/images/completer-example-qdirmodel.png b/examples/widgets/doc/images/completer-example-qdirmodel.png new file mode 100644 index 0000000000..904c198792 Binary files /dev/null and b/examples/widgets/doc/images/completer-example-qdirmodel.png differ diff --git a/examples/widgets/doc/src/completer.qdoc b/examples/widgets/doc/src/completer.qdoc index d74e19f28b..dcb15d2ef8 100644 --- a/examples/widgets/doc/src/completer.qdoc +++ b/examples/widgets/doc/src/completer.qdoc @@ -28,7 +28,7 @@ /*! \example tools/completer \title Completer Example - \ingroup example-widgets-tools + \ingroup examples-widgets-tools \brief The Completer example shows how to provide string-completion facilities for an input widget based on data provided by a model. diff --git a/examples/widgets/doc/src/regexp.qdoc b/examples/widgets/doc/src/regexp.qdoc index 562075cace..9dc3878c10 100644 --- a/examples/widgets/doc/src/regexp.qdoc +++ b/examples/widgets/doc/src/regexp.qdoc @@ -28,7 +28,7 @@ /*! \example tools/regexp \title Regular Expressions Example - \ingroup example-widgets-tools + \ingroup examples-widgets-tools \brief The Regular Expressions (RegExp) example shows how regular expressions in Qt are applied to text by providing an environment in which new regular expressions can be -- cgit v1.2.3