From cd621c201ca637385c6e3409d5c84ecec5fb5418 Mon Sep 17 00:00:00 2001 From: Casper van Donderen Date: Fri, 16 Sep 2011 14:14:43 +0200 Subject: [PATCH] Move the module qdoc files from qtdoc and split up doc/src. Change-Id: I7d992889379d78e07a0b7023facebd7421cf6d22 Reviewed-on: http://codereview.qt-project.org/5092 Reviewed-by: Qt Sanity Bot Reviewed-by: Jerome Pasion --- .../{ => core}/objectmodel/metaobjects.qdoc | 0 doc/src/{ => core}/objectmodel/object.qdoc | 0 .../{ => core}/objectmodel/objecttrees.qdoc | 0 .../{ => core}/objectmodel/properties.qdoc | 0 .../objectmodel/signalsandslots.qdoc | 0 doc/src/{tutorials => core}/threads.qdoc | 0 doc/src/dbus/qtdbus.qdoc | 40 +++++++++++++++++++ .../coordsys.qdoc | 0 .../paintsystem.qdoc | 0 doc/src/gui/qtgui.qdoc | 12 ++++++ .../files-and-resources/datastreamformat.qdoc | 0 .../files-and-resources/resources.qdoc | 0 .../network-programming/bearermanagement.qdoc | 0 .../network-programming/qtnetwork.qdoc | 0 .../network-programming/ssl.qdoc | 0 doc/src/network/qtnetwork.qdoc | 18 +++++++++ .../printing.qdoc | 0 doc/src/printsupport/qtprintsupport.qdoc | 19 +++++++++ doc/src/sql/qtsql.qdoc | 18 +++++++++ .../sql-programming/qsqldatatype-table.qdoc | 0 .../{ => sql}/sql-programming/sql-driver.qdoc | 0 .../sql-programming/sql-programming.qdoc | 0 .../addressbook-fr.qdoc | 0 .../{tutorials => widgets}/addressbook.qdoc | 0 doc/src/{tutorials => widgets}/modelview.qdoc | 0 doc/src/widgets/qtwidgets.qdoc | 18 +++++++++ .../widgets-and-layouts/focus.qdoc | 0 .../widgets-and-layouts/gallery-cde.qdoc | 0 .../gallery-cleanlooks.qdoc | 0 .../widgets-and-layouts/gallery-gtk.qdoc | 0 .../gallery-macintosh.qdoc | 0 .../widgets-and-layouts/gallery-motif.qdoc | 0 .../gallery-plastique.qdoc | 0 .../widgets-and-layouts/gallery-windows.qdoc | 0 .../gallery-windowsvista.qdoc | 0 .../gallery-windowsxp.qdoc | 0 .../widgets-and-layouts/gallery.qdoc | 0 .../widgets-and-layouts/layout.qdoc | 0 .../widgets-and-layouts/styles.qdoc | 0 .../widgets-and-layouts/stylesheet.qdoc | 0 .../widgets-and-layouts/widgets.qdoc | 0 .../widgets-tutorial.qdoc | 0 .../windows-and-dialogs/dialogs.qdoc | 0 .../windows-and-dialogs/mainwindow.qdoc | 0 doc/src/xml/qtxml.qdoc | 23 +++++++++++ 45 files changed, 148 insertions(+) rename doc/src/{ => core}/objectmodel/metaobjects.qdoc (100%) rename doc/src/{ => core}/objectmodel/object.qdoc (100%) rename doc/src/{ => core}/objectmodel/objecttrees.qdoc (100%) rename doc/src/{ => core}/objectmodel/properties.qdoc (100%) rename doc/src/{ => core}/objectmodel/signalsandslots.qdoc (100%) rename doc/src/{tutorials => core}/threads.qdoc (100%) create mode 100644 doc/src/dbus/qtdbus.qdoc rename doc/src/{painting-and-printing => gui}/coordsys.qdoc (100%) rename doc/src/{painting-and-printing => gui}/paintsystem.qdoc (100%) create mode 100644 doc/src/gui/qtgui.qdoc rename doc/src/{ => network}/files-and-resources/datastreamformat.qdoc (100%) rename doc/src/{ => network}/files-and-resources/resources.qdoc (100%) rename doc/src/{ => network}/network-programming/bearermanagement.qdoc (100%) rename doc/src/{ => network}/network-programming/qtnetwork.qdoc (100%) rename doc/src/{ => network}/network-programming/ssl.qdoc (100%) create mode 100644 doc/src/network/qtnetwork.qdoc rename doc/src/{painting-and-printing => printsupport}/printing.qdoc (100%) create mode 100644 doc/src/printsupport/qtprintsupport.qdoc create mode 100644 doc/src/sql/qtsql.qdoc rename doc/src/{ => sql}/sql-programming/qsqldatatype-table.qdoc (100%) rename doc/src/{ => sql}/sql-programming/sql-driver.qdoc (100%) rename doc/src/{ => sql}/sql-programming/sql-programming.qdoc (100%) rename doc/src/{tutorials => widgets}/addressbook-fr.qdoc (100%) rename doc/src/{tutorials => widgets}/addressbook.qdoc (100%) rename doc/src/{tutorials => widgets}/modelview.qdoc (100%) create mode 100644 doc/src/widgets/qtwidgets.qdoc rename doc/src/{ => widgets}/widgets-and-layouts/focus.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-cde.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-cleanlooks.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-gtk.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-macintosh.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-motif.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-plastique.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-windows.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-windowsvista.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery-windowsxp.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/gallery.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/layout.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/styles.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/stylesheet.qdoc (100%) rename doc/src/{ => widgets}/widgets-and-layouts/widgets.qdoc (100%) rename doc/src/{tutorials => widgets}/widgets-tutorial.qdoc (100%) rename doc/src/{ => widgets}/windows-and-dialogs/dialogs.qdoc (100%) rename doc/src/{ => widgets}/windows-and-dialogs/mainwindow.qdoc (100%) create mode 100644 doc/src/xml/qtxml.qdoc diff --git a/doc/src/objectmodel/metaobjects.qdoc b/doc/src/core/objectmodel/metaobjects.qdoc similarity index 100% rename from doc/src/objectmodel/metaobjects.qdoc rename to doc/src/core/objectmodel/metaobjects.qdoc diff --git a/doc/src/objectmodel/object.qdoc b/doc/src/core/objectmodel/object.qdoc similarity index 100% rename from doc/src/objectmodel/object.qdoc rename to doc/src/core/objectmodel/object.qdoc diff --git a/doc/src/objectmodel/objecttrees.qdoc b/doc/src/core/objectmodel/objecttrees.qdoc similarity index 100% rename from doc/src/objectmodel/objecttrees.qdoc rename to doc/src/core/objectmodel/objecttrees.qdoc diff --git a/doc/src/objectmodel/properties.qdoc b/doc/src/core/objectmodel/properties.qdoc similarity index 100% rename from doc/src/objectmodel/properties.qdoc rename to doc/src/core/objectmodel/properties.qdoc diff --git a/doc/src/objectmodel/signalsandslots.qdoc b/doc/src/core/objectmodel/signalsandslots.qdoc similarity index 100% rename from doc/src/objectmodel/signalsandslots.qdoc rename to doc/src/core/objectmodel/signalsandslots.qdoc diff --git a/doc/src/tutorials/threads.qdoc b/doc/src/core/threads.qdoc similarity index 100% rename from doc/src/tutorials/threads.qdoc rename to doc/src/core/threads.qdoc diff --git a/doc/src/dbus/qtdbus.qdoc b/doc/src/dbus/qtdbus.qdoc new file mode 100644 index 0000000000..fa91f67a85 --- /dev/null +++ b/doc/src/dbus/qtdbus.qdoc @@ -0,0 +1,40 @@ +/*! + \module QtDBus + \title QtDBus module + \ingroup modules + + \keyword QtDBus + \target The QDBus compiler + + \brief The QtDBus module is a Unix-only library that you can use + to perform Inter-Process Communication using the \l{D-Bus} protocol. + + Applications using the QtDBus module can provide services to + other, remote applications by exporting objects, as well as use + services exported by those applications by placing calls and + accessing properties. + + The QtDBus module provides an interface that extends the Qt \l + {signalsandslots.html}{Signals and Slots} mechanism, allowing one + to connect to a signal emitted remotely as well as to connect a + local signal to remote slot. + + To use this module, use the following code in your application: + + \snippet doc/src/snippets/code/doc_src_qtdbus.cpp 0 + + If you're using qmake to build your application, you can add this + line to your .pro file to make it link against the QtDBus + libraries: + + \snippet doc/src/snippets/code/doc_src_qtdbus.pro 1 + + \note The source code for this module is located in the \c{src/qdbus} + directory. When installing Qt from source, this module is built when Qt's + tools are built. + + See the \l {D-Bus} page for detailed information on + how to use this module. + + This module is part of all \l{Qt editions}. +*/ diff --git a/doc/src/painting-and-printing/coordsys.qdoc b/doc/src/gui/coordsys.qdoc similarity index 100% rename from doc/src/painting-and-printing/coordsys.qdoc rename to doc/src/gui/coordsys.qdoc diff --git a/doc/src/painting-and-printing/paintsystem.qdoc b/doc/src/gui/paintsystem.qdoc similarity index 100% rename from doc/src/painting-and-printing/paintsystem.qdoc rename to doc/src/gui/paintsystem.qdoc diff --git a/doc/src/gui/qtgui.qdoc b/doc/src/gui/qtgui.qdoc new file mode 100644 index 0000000000..fd3bcac5a1 --- /dev/null +++ b/doc/src/gui/qtgui.qdoc @@ -0,0 +1,12 @@ +/*! + \module QtGui + \title QtGui Module + \ingroup modules + + \brief The QtGui module extends QtCore with GUI functionality. + + To include the definitions of both modules' classes, use the + following directive: + + \snippet doc/src/snippets/code/doc_src_qtgui.pro 0 +*/ diff --git a/doc/src/files-and-resources/datastreamformat.qdoc b/doc/src/network/files-and-resources/datastreamformat.qdoc similarity index 100% rename from doc/src/files-and-resources/datastreamformat.qdoc rename to doc/src/network/files-and-resources/datastreamformat.qdoc diff --git a/doc/src/files-and-resources/resources.qdoc b/doc/src/network/files-and-resources/resources.qdoc similarity index 100% rename from doc/src/files-and-resources/resources.qdoc rename to doc/src/network/files-and-resources/resources.qdoc diff --git a/doc/src/network-programming/bearermanagement.qdoc b/doc/src/network/network-programming/bearermanagement.qdoc similarity index 100% rename from doc/src/network-programming/bearermanagement.qdoc rename to doc/src/network/network-programming/bearermanagement.qdoc diff --git a/doc/src/network-programming/qtnetwork.qdoc b/doc/src/network/network-programming/qtnetwork.qdoc similarity index 100% rename from doc/src/network-programming/qtnetwork.qdoc rename to doc/src/network/network-programming/qtnetwork.qdoc diff --git a/doc/src/network-programming/ssl.qdoc b/doc/src/network/network-programming/ssl.qdoc similarity index 100% rename from doc/src/network-programming/ssl.qdoc rename to doc/src/network/network-programming/ssl.qdoc diff --git a/doc/src/network/qtnetwork.qdoc b/doc/src/network/qtnetwork.qdoc new file mode 100644 index 0000000000..084cebd497 --- /dev/null +++ b/doc/src/network/qtnetwork.qdoc @@ -0,0 +1,18 @@ +/*! + \module QtNetwork + \title QtNetwork Module + \ingroup modules + + \brief The QtNetwork module provides classes to make network programming + easier and portable. + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc/src/snippets/code/doc_src_qtnetwork.cpp 1 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet doc/src/snippets/code/doc_src_qtnetwork.pro 0 +*/ diff --git a/doc/src/painting-and-printing/printing.qdoc b/doc/src/printsupport/printing.qdoc similarity index 100% rename from doc/src/painting-and-printing/printing.qdoc rename to doc/src/printsupport/printing.qdoc diff --git a/doc/src/printsupport/qtprintsupport.qdoc b/doc/src/printsupport/qtprintsupport.qdoc new file mode 100644 index 0000000000..d143d66ad2 --- /dev/null +++ b/doc/src/printsupport/qtprintsupport.qdoc @@ -0,0 +1,19 @@ +/*! + \module QtPrintSupport + \title QtPrintSupport Module + \ingroup modules + + \brief The QtPrintSupport module provides classes to make printing + easier and portable. + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc/src/snippets/code/doc_src_qtprintsupport.cpp 1 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet doc/src/snippets/code/doc_src_qtprintsupport.pro 0 +*/ + diff --git a/doc/src/sql/qtsql.qdoc b/doc/src/sql/qtsql.qdoc new file mode 100644 index 0000000000..fb05985874 --- /dev/null +++ b/doc/src/sql/qtsql.qdoc @@ -0,0 +1,18 @@ +/*! + \module QtSql + \title QtSql Module + \ingroup modules + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc/src/snippets/code/doc_src_qtsql.cpp 0 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet doc/src/snippets/code/doc_src_qtsql.pro 1 + + See the \l{SQL Programming} guide for information about using this + module in your applications. +*/ diff --git a/doc/src/sql-programming/qsqldatatype-table.qdoc b/doc/src/sql/sql-programming/qsqldatatype-table.qdoc similarity index 100% rename from doc/src/sql-programming/qsqldatatype-table.qdoc rename to doc/src/sql/sql-programming/qsqldatatype-table.qdoc diff --git a/doc/src/sql-programming/sql-driver.qdoc b/doc/src/sql/sql-programming/sql-driver.qdoc similarity index 100% rename from doc/src/sql-programming/sql-driver.qdoc rename to doc/src/sql/sql-programming/sql-driver.qdoc diff --git a/doc/src/sql-programming/sql-programming.qdoc b/doc/src/sql/sql-programming/sql-programming.qdoc similarity index 100% rename from doc/src/sql-programming/sql-programming.qdoc rename to doc/src/sql/sql-programming/sql-programming.qdoc diff --git a/doc/src/tutorials/addressbook-fr.qdoc b/doc/src/widgets/addressbook-fr.qdoc similarity index 100% rename from doc/src/tutorials/addressbook-fr.qdoc rename to doc/src/widgets/addressbook-fr.qdoc diff --git a/doc/src/tutorials/addressbook.qdoc b/doc/src/widgets/addressbook.qdoc similarity index 100% rename from doc/src/tutorials/addressbook.qdoc rename to doc/src/widgets/addressbook.qdoc diff --git a/doc/src/tutorials/modelview.qdoc b/doc/src/widgets/modelview.qdoc similarity index 100% rename from doc/src/tutorials/modelview.qdoc rename to doc/src/widgets/modelview.qdoc diff --git a/doc/src/widgets/qtwidgets.qdoc b/doc/src/widgets/qtwidgets.qdoc new file mode 100644 index 0000000000..05062b52db --- /dev/null +++ b/doc/src/widgets/qtwidgets.qdoc @@ -0,0 +1,18 @@ +/*! + \module QtWidgets + \title QtWidgets Module + \ingroup modules + + \brief The QtWidgets module extends QtGui with C++ widget functionality. + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc/src/snippets/code/doc_src_qtwidgets.cpp 1 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet doc/src/snippets/code/doc_src_qtwidgets.pro 0 +*/ + diff --git a/doc/src/widgets-and-layouts/focus.qdoc b/doc/src/widgets/widgets-and-layouts/focus.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/focus.qdoc rename to doc/src/widgets/widgets-and-layouts/focus.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-cde.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-cde.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-cde.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-cde.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-cleanlooks.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-cleanlooks.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-cleanlooks.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-cleanlooks.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-gtk.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-gtk.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-gtk.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-gtk.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-macintosh.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-macintosh.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-macintosh.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-macintosh.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-motif.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-motif.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-motif.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-motif.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-plastique.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-plastique.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-plastique.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-plastique.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-windows.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-windows.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-windows.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-windows.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-windowsvista.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-windowsvista.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-windowsvista.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-windowsvista.qdoc diff --git a/doc/src/widgets-and-layouts/gallery-windowsxp.qdoc b/doc/src/widgets/widgets-and-layouts/gallery-windowsxp.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery-windowsxp.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery-windowsxp.qdoc diff --git a/doc/src/widgets-and-layouts/gallery.qdoc b/doc/src/widgets/widgets-and-layouts/gallery.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/gallery.qdoc rename to doc/src/widgets/widgets-and-layouts/gallery.qdoc diff --git a/doc/src/widgets-and-layouts/layout.qdoc b/doc/src/widgets/widgets-and-layouts/layout.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/layout.qdoc rename to doc/src/widgets/widgets-and-layouts/layout.qdoc diff --git a/doc/src/widgets-and-layouts/styles.qdoc b/doc/src/widgets/widgets-and-layouts/styles.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/styles.qdoc rename to doc/src/widgets/widgets-and-layouts/styles.qdoc diff --git a/doc/src/widgets-and-layouts/stylesheet.qdoc b/doc/src/widgets/widgets-and-layouts/stylesheet.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/stylesheet.qdoc rename to doc/src/widgets/widgets-and-layouts/stylesheet.qdoc diff --git a/doc/src/widgets-and-layouts/widgets.qdoc b/doc/src/widgets/widgets-and-layouts/widgets.qdoc similarity index 100% rename from doc/src/widgets-and-layouts/widgets.qdoc rename to doc/src/widgets/widgets-and-layouts/widgets.qdoc diff --git a/doc/src/tutorials/widgets-tutorial.qdoc b/doc/src/widgets/widgets-tutorial.qdoc similarity index 100% rename from doc/src/tutorials/widgets-tutorial.qdoc rename to doc/src/widgets/widgets-tutorial.qdoc diff --git a/doc/src/windows-and-dialogs/dialogs.qdoc b/doc/src/widgets/windows-and-dialogs/dialogs.qdoc similarity index 100% rename from doc/src/windows-and-dialogs/dialogs.qdoc rename to doc/src/widgets/windows-and-dialogs/dialogs.qdoc diff --git a/doc/src/windows-and-dialogs/mainwindow.qdoc b/doc/src/widgets/windows-and-dialogs/mainwindow.qdoc similarity index 100% rename from doc/src/windows-and-dialogs/mainwindow.qdoc rename to doc/src/widgets/windows-and-dialogs/mainwindow.qdoc diff --git a/doc/src/xml/qtxml.qdoc b/doc/src/xml/qtxml.qdoc new file mode 100644 index 0000000000..20d7600935 --- /dev/null +++ b/doc/src/xml/qtxml.qdoc @@ -0,0 +1,23 @@ +/*! + \module QtXml + \title QtXml Module + \ingroup modules + \ingroup technology-apis + + \brief The QtXml module provides a stream reader and writer for + XML documents, and C++ implementations of SAX and DOM. + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc/src/snippets/code/doc_src_qtxml.cpp 0 + + To link against the module, add this line to your \l qmake \c + .pro file: + + \snippet doc/src/snippets/code/doc_src_qtxml.pro 1 + + Further XML support is provided by the \l{Qt Solutions} group who + provide, for example, classes that support SOAP and MML with the + Qt XML classes. +*/