summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc
Commit message (Collapse)AuthorAgeFilesLines
* Make QtQuick documentation references workPaul Olav Tvete2012-11-232-3/+9
| | | | | | | | ...and add one where we used to say that QWidget is "the base class of everything that appears on the screen". Change-Id: I573d8162fd69b7bfc5b0305f3ed6530129386b78 Reviewed-by: Samuel Rødal <samuel.rodal@digia.com>
* Added doc with IO functionsNico Vertriest2012-11-201-0/+109
| | | | | | | | | | | | | | Minor spelling and editorial issues see remarks J.Pasion 30 Oct. Corrected syllabifying error and minor punctuation issue Added link to Qt Core in introduction Change-Id: I1516c94c7f9b70125801ab7f9dfeeaed94db6d91 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Cleaning up QHP information in module configuration files.Jerome Pasion2012-11-071-12/+6
| | | | | | | | | | | | | | | | | | | | | There is a common standard among all Qt modules. These changes affect the final .qch file for each module. Changes: 1)URL in qt-project.org is confirmed by DevNet maintainer url = http://qt-project.org/doc/<module> 2)Landing page title mapping indexTitle = landing page 3)"C++ Classes" as a child node. The list of C++ classes and the titles are specified in the wiki. 4)Removed extra subprojects. They are not needed for now. Each module may need additional nodes. Change-Id: I1825476c21fe9aaddc9d6b512ff74229f17271a0 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Merge branch 'master' of ssh://codereview.qt-project.org/qt/qtbase into newdocsJerome Pasion2012-11-0214-91/+270
|\ | | | | | | Change-Id: I7e6cee190a341901dfbf8effb54ebccb91bf7a17
| * Use fusion instead of motif.Frederik Gladhorn2012-11-021-1/+1
| | | | | | | | | | Change-Id: Ic75ea959ac825efabf0f3a8606dfca4b65fae474 Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
| * Update QDateTime serialisation docs and increase version number.Mitch Curtis2012-11-021-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Refer to Qt::TimeSpec instead of listing potential values (which are incomplete). Also, the current QDataStream version number is now 13. Change-Id: I9a68385977dc2fe4dacee75330cb539850478480 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com>
| * Improve / fix QRegularExpression* docsGiuseppe D'Angelo2012-11-011-35/+89
| | | | | | | | | | | | | | | | | | | | | | Fixed a couple of typos; also, wrapped the snippets in a main() function, so that now the snippet file can be compiled (and therefore the compiler can help us at detecting those typos). Change-Id: Ie182a9c4cb451db13a6f4bfa5eaed66bc6966c8f Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@gmail.com> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
| * Qt Core: Removed unnecessary group membership.Jerome Pasion2012-11-012-19/+0
| | | | | | | | | | | | | | | | The 'Non-GUI Classes' page is not relevant. Also removed landing page from the 'modules' group. Change-Id: Ie2d34d36f98a4697becfebd5fbc215913bbb41ce Reviewed-by: Martin Smith <martin.smith@digia.com>
| * Qt Core: Adding a landing page and sorted the documentation.Jerome Pasion2012-10-2611-39/+183
| | | | | | | | | | | | | | | | -Added \annotatedlist for the groups -Sorted and placed the pages on the index page. Change-Id: Id1a4344c0b39f00036f5ac29b1fcb869d5602d2b Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* | Doc: Removed the HTML template from the .qdocconf filesJerome Pasion2012-10-261-1/+0
| | | | | | | | | | | | | | -qt-module-defaults.qdocconf already contains the HTML template. Change-Id: I5757741166f0f688ce0e8a4e77ed45fd4d72f1c7 Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'gerrit/master' into newdocsTor Arne Vestbø2012-10-266-29/+533
|\| | | | | | | Change-Id: I10cf9f915c602c8e5a0e7d7c9e17b7bc5ca00640
| * Update QDataStream format docs for gui/math3d classesSean Harmer2012-10-251-29/+29
| | | | | | | | | | | | Change-Id: I158d1bc5414f273320f0561000e69c3e06f6ac5a Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
| * Doc: Adding Event System documentation.Jerome Pasion2012-10-195-0/+504
| | | | | | | | | | | | | | Previously in qtdoc repository. Change-Id: I9f5cc876f2b49e86520097c0d8efe7e21eabc04e Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Merge remote-tracking branch 'gerrit/master' into newdocsTor Arne Vestbø2012-10-192-2/+3
|\| | | | | | | Change-Id: If7f46d56cf0b0b79f7fc8955a01964121b900d07
| * Review of documentation.Michele Caini2012-10-191-1/+1
| | | | | | | | | | | | | | Documentation has been updated to reflect changes in Qt5. Change-Id: I378858cf61f4bf62375c30c3903818d754dadcf0 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
| * Review of documentation.Michele Caini2012-10-161-1/+2
| | | | | | | | | | | | | | | | Documentation has been updated, changes apply to Qt5 as well as Qt4. Change-Id: I692869971bafffabbb9c323dc031f6d984c1adb9 Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
* | doc: Add a bunch of missing dependsTor Arne Vestbø2012-10-161-1/+1
| | | | | | | | Change-Id: I32c3730f8181d73a7c8e36ef382c74b8da754269
* | doc: add missing dep from qtcore to qtguiTor Arne Vestbø2012-10-121-1/+1
|/ | | | | | Change-Id: Ie7cf8236b376376a320e2de5ca65d2cd7da91c2f Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
* Modularize documenation buildTor Arne Vestbø2012-10-101-3/+2
| | | | | | | | | | qdocconf files can now reference $QT_INSTALL_DOCS to pick up e.g. global includes, instead of using relative paths. Qt modules will automatically get a doc target that builds and installs into the right place (including supporting shadow-builds) if they set QMAKE_DOCS before loading(qt_module). Change-Id: Ia408385199e56e3ead0afa45645a059d1a8b0d48 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@digia.com>
* Doc: Update QThread class ref to reflect changes since Qt 4.4Sze Howe Koh2012-10-081-9/+31
| | | | | | | | | | | | | | Remove advice to subclass QThread; promote thinking of QThread as a thread manager, not a thread; promote event-driven programming over time micromanagement; warn against common pitfalls. Result of collaboration in forum (https://qt-project.org/forums/viewthread/20691/) and mailing list (https://qt-project.org/pipermail/development/2012-September/006738.html) Task-number: QTBUG-16358 Change-Id: I57e3873976fad489176cbf9f7e680fd6992a8837 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
* Move QFutureSynchronizer back to QtCoreMarc Mutz2012-09-281-0/+53
| | | | | | | This class, too, belongs with QFuture. Change-Id: I41a532ca66c156f1631e4b22ffc1a5879c854488 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Move QFutureWatcher back to QtCoreMarc Mutz2012-09-281-0/+50
| | | | | | | | This belongs with QFuture. Change-Id: I555cd01c1d3890fbbaca4fd8a9170292ea4eb0fb Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Move QFuture from QtConcurrent to QtCoreMarc Mutz2012-09-281-0/+64
| | | | | | | | | This class belongs to QThreadPool/QRunnable more than to QtConcurrent, so move to QtCore, where QThreadPool awaits it. Change-Id: Ibf20288a986593bf779453427c2dae8db1e1423a Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Move QtConcurrent::Exception as QException back to QtCoreMarc Mutz2012-09-281-0/+75
| | | | | | | | | Leave the old name as a deprecated typedef; adapt users. This is a prerequisite for moving QFuture back to QtCore. Change-Id: I81dcee2c7e6eb234c16f3f42e2415ca0da3dc4f8 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* QStringList: adapt documentation to cover new join(QChar) overloadMarc Mutz2012-09-221-2/+2
| | | | | Change-Id: Ia73501e1e8a562cfab750d1796fb597cd89eab74 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-22140-982/+982
| | | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: If1cc974286d29fd01ec6c19dd4719a67f4c3f00e Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Fix QAbstractItemModel documentation errors.Mitch Curtis2012-09-131-1/+4
| | | | | | | | | | Added a dependency on the qtwidgets module to qtcore.qdocconf so that it has access to widgets examples. Also added examples/widgets to exampledirs. Change-Id: I7a69f51d51b65bd534950f0df5b348d6ef61a5d9 Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
* Fix QByteArray documentation errors.Mitch Curtis2012-09-131-0/+5
| | | | | | | | Add missing external resource link. Provide constructor documentation. Change-Id: I6d28a19da5c409dd0e0b48e0f693837b63de38f0 Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
* Several modifications in phrasing.Nico Vertriest2012-09-111-13/+12
| | | | | | | | Corrections of syntactic and spelling errors. Change-Id: I9d880b4d3f33ace53815d734f99d0b0396497158 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
* Fix example includes for qdoc.Frederik Gladhorn2012-09-111-3/+3
| | | | | | Change-Id: Ifa6a99db27ce51529489bf077a839a3107b524d2 Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Paul Olav Tvete <paul.tvete@nokia.com>
* Do not include /examples in qdocconfs.Frederik Gladhorn2012-09-111-1/+1
| | | | | Change-Id: I84a925a8be4964fae667f5a2500157283a8057d2 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>
* Doc: Centralize more common settings in 1 global qdocconf.Casper van Donderen2012-09-111-36/+1
| | | | | | | | | | All qdocconf settings that should be used by all Qt modules are now in qt-module-defaults.qdocconf. Change-Id: I2a0315a55db3fcbb0160c4392d2da98611043d83 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com> Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
* DON'T parse the header files of guiJan-Arve Saether2012-09-101-2/+1
| | | | | | | | | | | This should not be encouraged, and it currently breaks cross-module linking for qdoc. With this in place, we can actually generated cross-references downwards (e.g. from corelib to gui), although in a bit hackish way at the moment. Change-Id: I32919e04535464438e3bb83e41f9a40b752c71c6 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Fix QRegularExpression* docsGiuseppe D'Angelo2012-09-071-2/+2
| | | | | | | | | A couple of runaway backslashes resulted in illegal code in the examples. Change-Id: Ib00d4e1d792e44bb73dafdd84c3a1843dcb34e27 Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Robin Burchell <robin+qt@viroteck.net>
* Clarify QDateTime documentation re timeSpec conversion.Mitch Curtis2012-09-031-1/+36
| | | | | | | | | Clarify the documentation for setTimeSpec, toTimeSpec, toUTC and toLocalTime, to be clear on which ones return the same point in time, and which one simply changes the timezone. Change-Id: Ic47dd8876ea733f1df0f64eca5bdf00d04f8d0d4 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Fix docbuild when not using -developer-build.Casper van Donderen2012-09-011-2/+2
| | | | | | | | https://codereview.qt-project.org/#change,33974 only works in the case of a developer build. Not in a normal prefix build. Change-Id: I3a3e5029cefaa9f83c5deb71665f0efa9d812819 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
* Doc: Simplify qtbase qdocconfs.Casper van Donderen2012-08-311-15/+2
| | | | | | | | | | We should be using the global qdocconf for the common variables. This change also allows you to just specify -installdir without using a templatedir. Change-Id: I207d279d9b5199212e896fc5ccab5c212b1896c6 Reviewed-by: Lars Knoll <lars.knoll@nokia.com> Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
* Exclude the examples/widgets/doc dir for all but widgets.Frederik Gladhorn2012-08-291-0/+2
| | | | | | | | There are too many references to the QWidget lib documentation in there. On the other hand this keeps snippets working. Change-Id: I7dd63b7fba1758accea2663f7b427940a8857e32 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* doc: remove links to Qt DesignerFrederik Gladhorn2012-08-281-2/+2
| | | | | | | | Designer is in the tools repo, we cannot link there. Mentioning the name should be good enough. Change-Id: I55193aa31e60ae266a8890f706c332a63ed3610d Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Make sure we don't get duplicated doc pages.Lars Knoll2012-08-231-5/+0
| | | | | | | | | \group generates a page with the same name as the \page comand afterwards. Change-Id: Iaca6da21485532c8c3b13982bd06a06f3dbc0375 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Doc: Fix snippet and example referencing widget examplesAndy Nichols2012-08-232-5/+5
| | | | | | | | Widget examples were moved into a widgets subfolder, but qdoc references were not updated. Change-Id: Id2a4573e723745b9827c664c852807d6116f8f6d Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* A few more random documentation fixesShawn Rutledge2012-08-231-5/+6
| | | | | | | @p replaced by \a, \QD replaced by {Qt Designer}, couple of enums etc. Change-Id: I315510690bf52e42db519292b4122fa24c73bbc9 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
* Doc: Fix snippet bug in State Machine overview.Geir Vattekar2012-08-221-0/+1
| | | | | | Task-number: QTBUG-24719 Change-Id: Ia0c802f275eaf009e42ffef4cc538f3b3d7561d0 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Use QThread instead of QPushButton as an example in the docsLars Knoll2012-08-201-1/+1
| | | | | | | This keeps links local and inside the module. Change-Id: I5e267197c6356a2c4e231c1941ed4be33b96a16e Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Fix snippet bug in State Machine OverviewLars Knoll2012-08-201-1/+3
| | | | | | | | | Cherry-pick of b0facd481a2fc119d87c85481d97357d814a5fd2 from the qtdoc repository. Task-number: QTBUG-25314 Change-Id: I2166db46399ea6da8cadf02a7f65738c0c252142 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Move the statemachine documentation into qtcoreLars Knoll2012-08-1816-0/+1163
| | | | | | | | | Moved the documentation from qtdoc to here, so the statemachine class docs can link to it. Change-Id: I49a10cc7c418d415c64ea538376eb9bd7b031c27 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Move the animation overview doc into QtCoreLars Knoll2012-08-182-0/+364
| | | | | | | Moved here from the qtdoc module. Change-Id: Ib263848e0637204ec3b0cba973076ca79a25a953 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Add a module page for QtConcurrentLars Knoll2012-08-151-1/+1
| | | | | | | | Fix some foward references from QtCore in addition. This will require more work. Change-Id: Ib1bade18c2cc220a7afe25e9fca6a3f50cb1174b Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Doc: Added a Qt Network landing page.Jerome Pasion2012-08-102-3/+1
| | | | | | | | | | -fixed generated HTML file names -removed qt-network group in qt/qtdoc and removed \ingroup instances Change-Id: Ida5ded5da30e6db1978382f6742a5da8036e055e Reviewed-by: Shane Kearns <shane.kearns@accenture.com> Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Laszlo Papp <lpapp@kde.org>
* Clarify how days are counted in QDateTime::daysTo documentation.Mitch Curtis2012-08-081-0/+13
| | | | | | | | | Mention that the days are counted as the amount of times midnight is reached between the start and end date. Task-number: QTBUG-26780 Change-Id: I22ff6c56b748ac968d6991e0be3e10905c0634bd Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-24 04:40:31 +0000