diff options
author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-01-19 13:47:56 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2016-01-19 13:04:35 +0000 |
commit | 632e5eba37a628ba222b528c96682ed02d809223 (patch) | |
tree | 66e6c5173004838be2e26bf61fa79787599432df | |
parent | e16c94a0df7ebdada0355f50e2becbdbcff15aed (diff) |
Doc: Fix issues in QDoc Manual documentation
This commit partially reverts 23fc55c4bbf3cf334ff33f1b7816c35fdc67fd93
- adding example directories from outside the module boundaries caused
multiple warnings. Instead, copy-paste the required code snippet
directly into the source documentation.
Additionally, in qdoc.qdocconf,
- Remove obsolete 'imagedirs' path
- Remove obsolete dependencies
- Fix filter attributes
- Use up-to-date selectors for QHP
Change-Id: Ic2836e1e2e1da6b4aebcd0250af25e2b40cce196
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
-rw-r--r-- | src/qdoc/doc/config/qdoc.qdocconf | 21 | ||||
-rw-r--r-- | src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 18 |
2 files changed, 18 insertions, 21 deletions
diff --git a/src/qdoc/doc/config/qdoc.qdocconf b/src/qdoc/doc/config/qdoc.qdocconf index 30a5cb13d..cadc49e5d 100644 --- a/src/qdoc/doc/config/qdoc.qdocconf +++ b/src/qdoc/doc/config/qdoc.qdocconf @@ -7,13 +7,10 @@ version = $QT_VERSION sourcedirs = .. exampledirs = .. \ - ../examples \ - ../../../../../qtbase/src/gui/doc/ + ../examples imagedirs = ../images \ - ../../../../widgets/doc/images \ - ../../../../../qtbase/src/widgets/doc/images/ -# ../../../doc/src/templates/images + ../../../../../qtbase/src/widgets/doc/images tagfile = ../html/qdoc.tags @@ -27,20 +24,20 @@ qhp.QDoc.virtualFolder = qdoc qhp.QDoc.indexTitle = QDoc Manual qhp.QDoc.indexRoot = -qhp.QDoc.filterAttributes = qdoc qtrefdoc -qhp.QDoc.customFilters.QDoc.name = QDoc -qhp.QDoc.customFilters.QDoc.filterAttributes = qdoc +qhp.QDoc.filterAttributes = qdoc $QT_VERSION qtrefdoc +qhp.QDoc.customFilters.QDoc.name = QDoc $QT_VERSION +qhp.QDoc.customFilters.QDoc.filterAttributes = qdoc $QT_VERSION + qhp.QDoc.subprojects = overviews qhp.QDoc.subprojects.overviews.title = Overviews qhp.QDoc.subprojects.overviews.indexTitle = QDoc Manual -qhp.QDoc.subprojects.overviews.selectors = fake:page,group,module +qhp.QDoc.subprojects.overviews.selectors = doc:page depends += \ activeqt \ qtassistant \ qtbluetooth \ qtconcurrent \ - qtcontacts \ qtcore \ qtdbus \ qtdesigner \ @@ -53,7 +50,6 @@ depends += \ qtmultimedia \ qtnetwork \ qtopengl \ - qtorganizer \ qtprintsupport \ qtqml \ qtquick \ @@ -64,10 +60,7 @@ depends += \ qtsvg \ qttestlib \ qtuitools \ - qtversit \ qtwidgets \ - qtwebkit \ - qtwebkitexamples \ qtxml \ qtxmlpatterns diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index efacda540..2e82ad123 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -1731,13 +1731,17 @@ snippet file, as shown in the following example that corresponds to the above \c{\snippet} command: - \quotefromfile snippets/textdocument-resources/main.cpp - \skipto QImage::Format_RGB32 - \dots - \codeline - \printuntil QTextDocument::ImageResource - \printuntil Adding a resource - \dots + \code + ... + QImage image(64, 64, QImage::Format_RGB32); + image.fill(qRgb(255, 160, 128)); + +//! [Adding a resource] + document->addResource(QTextDocument::ImageResource, + QUrl("mydata://image.png"), QVariant(image)); +//! [Adding a resource] + ... + \endcode \target codeline-command \section1 \\codeline |