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 <qt_sanity_bot@ovi.com>
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
This commit is contained in:
Casper van Donderen 2011-09-16 14:14:43 +02:00 committed by Qt by Nokia
parent 20009ed797
commit cd621c201c
45 changed files with 148 additions and 0 deletions

40
doc/src/dbus/qtdbus.qdoc Normal file
View File

@ -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}.
*/

12
doc/src/gui/qtgui.qdoc Normal file
View File

@ -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
*/

View File

@ -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
*/

View File

@ -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
*/

18
doc/src/sql/qtsql.qdoc Normal file
View File

@ -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.
*/

View File

@ -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
*/

23
doc/src/xml/qtxml.qdoc Normal file
View File

@ -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.
*/