summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc/qtcore.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* Doc: corrected snippet issue in Defining Plugins docNico Vertriest2015-03-111-1/+2
| | | | | | Task-number: QTBUG-44629 Change-Id: I70e20209b6b33f7adcbcafc6b7d959660cdc2e87 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: corrected link/autolink issues in corelibNico Vertriest2015-02-241-1/+1
| | | | | | Task-number: QTBUG-43115 Change-Id: I31da92e3a7c4dd7b75ee283dbfecd77e284978ca Reviewed-by: Martin Smith <martin.smith@digia.com>
* Move Qt Core examples under a common subdirectoryTopi Reinio2014-10-171-5/+2
| | | | | | | | | | | | | | | | | | Qt Core examples were scattered into several subdirectories under qtbase/examples. This caused an issue with the example manifest file generated by QDoc; it expects to find all examples under a common directory in order to produde correct paths to the example .pro files. Qt Creator will not find the examples without a valid manifest file. This change moves the examples and edits the documentation files accordingly. Task-number: QTBUG-41963 Change-Id: I51d86782e0ba21c5c9bae5f15401ec774abe5cf8 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Removed "url" variable from qdocconf files.Jerome Pasion2014-07-041-1/+0
| | | | | | | | url is set in qtbase/doc/global which is inherited by the Qt 5 module qdocconf files. Change-Id: Ieffa174f598f4a3b8ce8be9bfae7ca9b6981f12b Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Remove Qt Core documentation dependency to Qt QMLTopi Reinio2014-04-281-1/+2
| | | | | | | | | | | | | When generating documentation, the Qt namespace declared in Qt Core collides with the Qt global object declared in Qt QML. This caused the C++ Qt namespace documentation to go missing. This change works around the issue by removing the dependency between Qt Core and Qt QML. Task-number: QTBUG-38630 Change-Id: Ifd250a19c476bc30e2a2ed561573c8b6b3b2dba5 Reviewed-by: Martin Smith <martin.smith@digia.com>
* docs: Q_CLASSINFO is used in a couple more places besides ActiveQtShawn Rutledge2014-04-141-1/+1
| | | | | | Change-Id: I000f538dc11477224efbf2edc91873822eb9fef2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Move IPC example documentationTopi Reinio2014-03-271-0/+1
| | | | | | | | | | | | Examples under examples/ipc were not part of any module documentation. This change adds the above folder to Qt Core documentation, and moves the corresponding files so that the example documentation is built correctly. Change-Id: If1f34ce7ef04a02df8a87f820bb2e68ffa723dd4 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Use QCommandLineParser in example dnslookup.Friedemann Kleint2014-03-151-1/+2
| | | | | | | | | | | Show how use QCommandLineParser with additional parameter checking for custom options and positional arguments. Also explain how to display help in GUI applications. Change-Id: I03513e09b7dd5b150259593da0af2ef2a281cab2 Reviewed-by: David Faure <david.faure@kdab.com>
* Doc: Fix broken linksSze Howe Koh2014-02-041-1/+1
| | | | | Change-Id: Ic275dfbf0b332fc34ea0fac1c31c4935ad961527 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
* Doc: fixed invalid referenceNico Vertriest2013-12-031-1/+1
| | | | | | | | | | Link to "Getting started with qmake" was invalid Task-number: QTBUG-34749 Change-Id: I782dc99f5182f2fe7661377eb82f35ebb50a46cf Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: Fix cross-module linksSze Howe Koh2013-11-061-1/+1
| | | | | | | | | | - Remove Active Qt -- it's not really plugin-related - Add QDoc dependencies - NOTE: Can't add Qt QML because QDoc would get confused between the C++ and QML "Qt" namespaces. Change-Id: I15a76dbd5235f13598a3802a815f7f49b80eac8a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Updated url variable in qdocconf files.Jerome Pasion2013-11-061-1/+1
| | | | | | | | | | | | | | In 5.2, the HTML output is in a flatter structure and when they are hosted in qt-project.org/doc, the documentation will be found at http://qt-project.org/doc/qt-$QT_VER The url variable is used by projects outside of Qt 5 which need to link to Qt 5 documentation, such as Qt Creator. Task-number: QTBUG-34584 Change-Id: Ifa55fcd9e402b0e184a41e316340e46aeb7101de Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Merge remote-tracking branch 'origin/stable' into devFrederik Gladhorn2013-08-271-1/+2
|\ | | | | | | | | | | | | Conflicts: examples/widgets/doc/src/addressbook-fr.qdoc Change-Id: Id1196e8e0c6445f1616c3f29234c974d809f8e48
| * Add json/savegame example.Mitch Curtis2013-08-221-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | There wasn't any example documentation besides json.html, which doesn't actually describe usage of the various QJson* classes. This also makes each QJson* class page link back to json.html. Change-Id: If5ad6493d2728df0cec7bdbbc5790f0b755f816c Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* | Doc: exclude snippets subdir.David Faure2013-08-071-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | This fixes the qdoc warning: doc/snippets/code/src_corelib_tools_qcommandlineparser.cpp:85: warning: Hostile character 0x24 in C++ source and doesn't lead to any loss in the generated documentation. Snippets are not "source files" for qdoc, they are included by source files. Change-Id: Ica0169813d71994ff258bf7c48f2fd387d33d772 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
* | Doc: Adding navigation configs in the module qdocconf files.Jerome Pasion2013-06-251-0/+3
|/ | | | | | | | -The navigation bar requires the titles of the landing page and relevant pages. Change-Id: I5d5986b2bf74205cd49957b63fd6ac4e32cbb36b Reviewed-by: Martin Smith <martin.smith@digia.com>
* fix doc page urlsOswald Buddenhagen2013-02-041-1/+1
| | | | | | | they are versioned nowadays Change-Id: I839db633e9d7d63c9d445f8e914b529bd7ce60a2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Merge "Merge branch 'release' into stable" into refs/staging/stableSergio Ahumada2013-02-011-2/+1
|\
| * Doc: Fixing snippets and input file for a Qt Core article.Jerome Pasion2013-01-281-2/+1
| | | | | | | | | | | | | | | | | | | | | | | | -copied snippet and input files from Qt Widgets. -adapted new paths in the resource-system.qdoc file. -removed the old path entry in qdocconf. Task-number: QTBUG-29101 Change-Id: Ieeb118106756a1a39890ab219294de18f437c56c Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* | substitute fixed version numbers in qdocconf files with variablesOswald Buddenhagen2013-02-011-5/+5
|/ | | | | | Change-Id: Ie57765c10a8e90d6fc74ee5a8fd84bfc7cd8bcf2 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
* Doc: added path to qtcore.qdocconfNico Vertriest2013-01-211-1/+1
| | | | | | | | | Added examples/widgets Required for resource-system.qdoc referring to application.qrc Task-number: QTBUG-29101 Change-Id: Ia51020a02801e04e3ff8d13f09277d7cd3fe1109 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Bump Qt version to 5.0.1Sergio Ahumada2012-12-211-5/+5
| | | | | Change-Id: Ie8f437b8dfe8a67c7b34321439dd988a02612437 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Moved content from qtdocVenugopal Shivashankar2012-12-141-1/+3
| | | | | | | | | | | - The qdoc pages were related to qtcore and they were referring to snippets inside the qtcore module boundary. - Fixed the exampledirs for QtCore to include the examples that are referred by the \snippet instances in the moved qdoc pages work. Change-Id: Ibb6dbb131920ea8692a203f6145863e5012e4602 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* QtBase: Doc: Fix Links to designer manual.David Schulz2012-12-101-1/+1
| | | | | Change-Id: I87f68fb70aa773c44b90b58bd56fc5585a7e4107 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* doc: Avoid duplicate widget example entriesEskil Abrahamsen Blomfeldt2012-12-061-2/+1
| | | | | | | | | | | | | | The link to widget examples in QtCore was added in 4519d810d1d2be3af17bdd77edac2361620f9d2d, which made widget examples pop up twice in generated lists (once for qtcore and once for qtwidgets documentation). I'm not sure why it was originally added to that module, but the snippets in the fridgemagnets example (which was the example fixed in the commit) has been verified to still work. Change-Id: I1b349f08349b5499929315d426224ba8638adc8e Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
* Doc: Fix some more linksChristian Stenger2012-12-051-1/+2
| | | | | Change-Id: I94c853532cd3ed9bf18e6d471f99560e04131fdf Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* QtBase: Added qtlinguist as a dependencie to the doc.David Schulz2012-12-041-1/+1
| | | | | Change-Id: I2df1cee84b250b75dc8436c8cff5df50cbeb0e01 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Fix links for threading examplesPaul Olav Tvete2012-11-301-3/+1
| | | | | Change-Id: I498936e91e3bbf5658ea9f3f0eb33cff271a1d62 Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
* Fix example paths in example manifests that are used by Qt Creator.Eike Ziller2012-11-261-0/+2
| | | | | | Task-number: QTBUG-27801 Change-Id: I345c009fc0e4e1c1eabb43ad142e3b474e7a6fee Reviewed-by: hjk <qthjk@ovi.com>
* Make QtQuick documentation references workPaul Olav Tvete2012-11-231-1/+1
| | | | | | | | ...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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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>
* Add gui/ to qtcore.qdocconf to pick up enums in Qt namespaceJeremy Katz2012-07-161-1/+2
| | | | | | | | | Qt::HitTestAccuracy and Qt::WhiteSpaceMode are defined in gui/ but documented as part of the Qt namespace, so qdoc needs to look there to find the relevant enums. Change-Id: I36ae71c44024b12664688129044994926160e5c9 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Doc: Add a default license footer.Casper van Donderen2012-05-111-0/+1
| | | | | | | | The CSS for the footer is not completely correct, but at this time it is better to have something than nothing. Change-Id: I7371e1e458a2abafcdb0fca5564ad73e209d64c3 Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
* Add "make docs" target for QtNetwork and sanitize other qdocconfs.Casper van Donderen2012-05-021-20/+20
| | | | | Change-Id: Ic9d6384b20162debeb69cb067c96c330c0fd999a Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
* Doc: Prepare for building modular QtCore docs.Casper van Donderen2012-04-191-0/+90
This change fixes most qdoc errors in QtCore. There are about 900 left. The main thing this change does is moving documentation from qtcore from /doc/src to /src/corelib/doc. Other issues resolved are mis-use of qdoc commands. Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1 Reviewed-by: Lars Knoll <lars.knoll@nokia.com> Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com> Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 10:48:29 +0000