summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/doc/qdoc-manual.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Update copyright headersJani Heikkinen2015-02-111-6/+6
| | | | | | | | | | | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Outdated header.LGPL removed (use header.LGPL21 instead) Old header.LGPL3 renamed to header.LGPL3-COMM to match actual licensing combination. New header.LGPL-COMM taken in the use file which were using old header.LGPL3 (src/plugins/platforms/android/extract.cpp) Added new header.LGPL3 containing Commercial + LGPLv3 + GPLv2 license combination Change-Id: I6f49b819a8a20cc4f88b794a8f6726d975e8ffbe Reviewed-by: Matti Paaso <matti.paaso@theqtcompany.com>
* qdoc: Update qdoc manualMartin Smith2015-01-021-0/+1
| | | | | | | | | | This update explains how to use the optional 'square bracket' argument for the link command (\l), the new single execution mode for qdoc, and how to generate and use the QA pages. Change-Id: I7232e05677c6ea97636cdb4fb20bd9708c83f311 Task-number: QTBUG-35495 Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Doc: split up Qdoc-manualNico Vertriest2013-09-101-8719/+0
| | | | | | | | | | | | | qdoc-manual.qdoc is now an overview document Each section is a separate qdoc file Title modification in minimal qdocconf qdoc file Task-number: QTBUG-31801 Change-Id: I9e50eb8c4f1f501e9c0bc768372d4393b73053ed Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: preliminary review of qdoc-manual.qdocNico Vertriest2013-08-081-323/+298
| | | | | | | | | | | | | - syntax - grammar - writing guidelines - spelling - added contents for \\note Task-number: QTBUG-31801 Change-Id: I9df1af270acd7fbad39048a47b883f3002e168e4 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Qdoc: replaced example file qt.qdocconf with qtgui.qdocconfNico Vertriest2013-06-121-35/+15
| | | | | | Task-number: QTBUG-31574 Change-Id: Idf8509395dd5f16c696473d1eeb91fb86f2b97e7 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Doc: Document example manifest files in QDoc manualTopi Reinio2013-02-201-0/+93
| | | | | | | | | Adds documentation for example manifest files and the related qdoc configuration command \manifestmeta into QDoc manual. Change-Id: I6a627698ab14f57c9a117b6d4b794f352959f5ac Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Removed reference to deprecated \badcode command.Jerome Pasion2013-02-191-72/+9
| | | | | | | | -QDoc doesn't differentiate between \badcode and \code. They both look the same in the output. Change-Id: Ifabd51b7e433a1c30cf30c267d3ce63dded1bd43 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
* Doc: Made QDoc Manual use Qt 5's qdocJerome Pasion2013-02-071-37/+37
| | | | | | | | | | | | -removed extra qdocconf and files -"make docs" using QMAKE_DOCS -installs the documentation in QT_INSTALL_DOCS -updated title of the manual to "QDoc Manual" -modified listing of contents in Assistant Change-Id: I22f93c0903c5e672a0e7efa83bf3f592658be66d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Fix a typo in the qdoc manualLaszlo Papp2013-02-071-1/+1
| | | | | Change-Id: I7eb6348562a18ce87e065950315dec3253a22aeb Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Nokia -> Qt ProjectFrederik Gladhorn2013-02-051-6/+6
| | | | | Change-Id: Iadd29ee918dc181d2a468f5198e66351c7cb3548 Reviewed-by: Simon Hausmann <simon.hausmann@digia.com>
* Doc: Fix module name formatSze Howe Koh2013-01-251-6/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Follow the conventions at http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation QtCore -> Qt Core QtDBus -> Qt D-Bus QtDesigner -> Qt Designer QtGui -> Qt GUI QtImageFormats -> Qt Image Formats QtNetwork -> Qt Network QtPrintSupport -> Qt Print Support QtScript -> Qt Script QtSql -> Qt SQL QtSvg -> Qt SVG QtTest -> Qt Test QtWebKit -> Qt WebKit QtWidgets -> Qt Widgets QtXml -> Qt XML QtConcurrent -> Qt Concurrent (partial) QtQuick -> Qt Quick (partial) Also, distinguish between "module" and "library" Change-Id: Icb8aa695ae60b0e45920b0c8fce4dc763a12b0cd Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-181-1/+1
| | | | | Change-Id: Ic804938fc352291d011800d21e549c10acac66fb Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: corrected typo "the the"Nico Vertriest2013-01-111-1/+1
| | | | | | | | | | | Task-number: QTBUG-28756 Spurious repetition of the definite article Trailing space issue corrected. Change-Id: I3a051f5dc291e546d8d67d6775e84b388bdc0363 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
* qdoc: Fix some old links and references to NokiaSergio Ahumada2013-01-101-68/+68
| | | | | | Change-Id: I06535a7e301c3986fb104b7092934e8925bacd39 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: hjk <qthjk@ovi.com>
* Remove reference to Qt 3 documentation from example qdoc code.hjk2012-11-301-3/+1
| | | | | Change-Id: I0999b24f12ee4c878fc2a95b171474eea7a55ba5 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* QDoc: remove the experimental basedir variablePierre Rossi2012-09-281-35/+0
| | | | | | | | | It was introduced in the early days of the docs' modularization and appears not to be used anywhere anymore. Change-Id: I5b0c60d92828624af2129153fce96ad01aec861c Reviewed-by: Martin Smith <martin.smith@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-221-14/+14
| | | | | | | | 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>
* QDoc manual: ordered command listJerome Pasion2012-09-141-3/+3
| | | | | | | | Some commands were not listed in alphabetical order. Change-Id: I299abe145ca0f9d63c9ceefb801f5c53548e7938 Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org> Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Doc: Fix spelling errorsSergio Ahumada2012-08-171-2/+2
| | | | | Change-Id: Ibae8d10183f6b15a16b1499daa2df8802dbb014e Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com>
* Fix a bug in qdocs handling of excludedirsJan-Arve Saether2012-08-171-7/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The bug was there because the way qdoc tries to exclude the directories given in the "excludedirs" variable: It did a simple string comparision on the candidate path (to include) with every string in the "excludedirs" variable. However, this did not work for all cases, since the paths are not canonicalized. For instance, the problem I faced was that the following qdocconf fragment: (config file located in doc/qtwidgets.qdocconf) sourcedirs += .. excludedirs += snippets Since qdoc would recursively parse all subfolders of sourcedirs, it would at one point visit the snippets folder, but it would have the relative path "../doc/snippets", which did not match with "snippets", causing snippets to not be excluded. In addition, it seems that qdoc tries hard not to use absolute paths (maybe because of more human-friendly error messages). I therefore chose to canonicalize the relative paths. As a side-effect this also give a better output from qdoc, as ../doc/foo.qdoc:42: Missing link will become foo.qdoc:42: Missing link Change-Id: If9c25fa569abd03542bd12675acd44d8f4e0282c Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Fix a typo in the qdoc manual (QChra -> QChar)Laszlo Papp2012-08-021-1/+1
| | | | | Change-Id: I331765f42f8dd46bf312223754ade3c5d156e6dc Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* qdoc: Updated qdoc manual and qdoc guideMartin Smith2012-07-271-7/+120
| | | | | | | | | | | These documents now include the \qmltype and \instantiates commands, and the \qmlclass command is deprecated. Task nr: QTBUG-26648 Change-Id: I62da273be51609e651e33b9088e1667e4c6c1e76 Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
* Use QDoc instead of Qdoc to be consistent with the rest of the documentationLaszlo Papp2012-07-081-1/+1
| | | | | Change-Id: Iec031e207609b87e3c85bec66a7aaebd971973d1 Reviewed-by: Richard J. Moore <rich@kde.org>
* Fix some typos in the qdoc manualLaszlo Papp2012-07-061-10/+10
| | | | | Change-Id: I7d5e4ad684556b6c96fde2dcbdce6c772856cc33 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Doc: Fix \sa usageMarius Storm-Olsen2012-05-111-1/+1
| | | | | | | | | Ensure comma between elements (757 missing), single space and curly- braces around title elements, etc. Change-Id: Id16c3fda7fc47a12a0682f8720214f4990609a97 Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* QDoc: Remove the unused \expire command.Casper van Donderen2012-05-081-37/+0
| | | | | Change-Id: I17108dee0a619cbff7627c86cddb8391857e169c Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc: Fixed bugs causing invalid DITA XMLMartin Smith2012-04-141-0/+7
| | | | | | | | | | | Fixed a bug in qdoc that caused too many end elements to be generated. Also fixed some doc errors that caused invalid DITA to be generated. Task nr: QTBUG-25302 Change-Id: Ifbbf457d28c51c2691a252888447739da7713bc9 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* QDoc documentation: modified the instructions for documenting signals.Jerome Pasion2012-04-031-16/+9
| | | | | | | | -we document signals, not signal handlers. Change-Id: I7d52223a393ff0530ead06dfb8a80479e34fd362 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc: Implement \uicontrol command.Casper van Donderen2012-03-281-0/+11
| | | | | Change-Id: I10381cd69d32352c590ec5a7d4041465af57b88b Reviewed-by: Martin Smith <martin.smith@nokia.com>
* QDoc: updating manual to use "type".Jerome Pasion2012-03-211-28/+28
| | | | | | | | | -updated both QDoc manual and QDoc guide -"QML element" and "QML component" should be "QML type" Change-Id: Ib2a0e8baa9087a04d35c05bbbd35852da10faf42 Reviewed-by: Martin Smith <martin.smith@nokia.com> Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Rename qdoc index file to qdoc-index.htmlCasper van Donderen2012-03-151-1/+1
| | | | | Change-Id: I74fcbce7d2929c31031db379d5e0b4b0d2f48800 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Rename all occurences of qdoc3 to qdoc in the qdoc manual.Casper van Donderen2012-03-151-6/+6
| | | | | Change-Id: I84cfab5a7130aff9ed8a6eb568d78f29167e1ac8 Reviewed-by: Martin Smith <martin.smith@nokia.com>
* qdoc3: qdoc user manual updateMartin Smith2012-03-101-704/+688
| | | | | | | | | Changed \bold to \b, \i to \e, and \o to \li. Task-number: QTBUG-24578 Change-Id: If02517164f30f05436596224c1b1895a86d9e9f8 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
* Move qdoc into qtbase and bootstrap itLars Knoll2012-03-081-0/+8780
We need qdoc in qtbase to be able to properly modularize our documentation and build it when building the different Qt modules. qdoc does contain a copy of the qml parser from qmldevtools, but this is the lesser evil compared to how we are currently forced to genereate our docs (and the fact that no developer can run qdoc and check the docs for their module). Change-Id: I9f748459382a11cf5d5153d1ee611d7a5d3f4ac1 Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-11 01:08:57 +0000