summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* qdoc: properly implement \typealias commandTopi Reinio2020-04-231-0/+36
| | | | | | | | | | | | | | | | | | \typealias was already a command recognized by QDoc, but it was simply treated as a synonym for \typedef and was not documented. Implement proper support for the command: - Add [alias] designation both in type summary and details. - Auto-generate information about the aliased type, including a link if aliasing a public, documented type. - Auto-convert aliases documented with \typedef to type aliases. - Add basic support for aliases also to DocBook and WebXML generators. - Document \typealias. Fixes: QTBUG-82712 Change-Id: Iafa8c7def0a7488d7521fbc2862290a9bb3167ff Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: QDoc Manual: Document \readonly and \inheaderfile commandsTopi Reinio2020-04-201-0/+2
| | | | | | | | Fixes: QTBUG-65585 Fixes: QTBUG-68280 Change-Id: I7843e2d597e27c2d46ffcafe67b6bfd624770455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: QDoc Manual: Refer to the tool as 'QDoc' consistentlyTopi Reinio2020-04-201-1/+1
| | | | | | | | And add 'QDoc' as a word ignored for auto-linking. Change-Id: I16a33b8448e8bfa340f4c62149f702fea13d5533 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QDoc: Add warning to use of \contentspage commandv5.15.0-beta2Paul Wicking2020-03-111-1/+0
| | | | | | | | | | | The \contentspage command doesn't produce nav links to the contents page between the next and previous pages. QDoc hasn't generated these links in html output since Qt 5.3. Remove the documentation that refers to the command and add a warning that it should not be used.. Task-number: QTBUG-75170 Change-Id: Ib16fc1cbb1e661a7519ba650e655e209c3b45b68 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.14' into 5.15Qt Forward Merge Bot2020-02-181-16/+8
| | | | | Change-Id: I98eaf748fdfb34f32d187718459327b8eef9c54b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Resolve documentation warningsTopi Reinio2019-11-111-6/+0
| | | | | | | | | | | | | - QDoc Manual: UIComponents example project has been moved to be a part of test case - remove references to it from the manual. - Add missing image. - Document the namespace qdesigner_internal as \internal. Fixes: QTBUG-79833 Change-Id: Ic0984cef4091e794de5e502d04a897b1f532d9d8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* qdoc: Allow replacing file lists on \example pages with a link to a URLv5.13.0-beta2Topi Reinio2019-04-091-1/+4
| | | | | | | | | | | | | | | | | | Source and image file lists that are automatically generated at the end of example pages have outlived their usefulness, at least for Qt docs. When browsing example documentation offline via Qt Creator's Help, the user has typically already opened the example project. For online documentation, a better option is to link to a remote repository where the user can browse the example's content. This commit adds a new configuration variable 'url.examples' - if defined, file listings are omitted and a link is constructed for each example based on the parameter passed to the \example command and the 'examplesinstallpath' configuration variable. Task-number: QTBUG-74391 Change-Id: If1f76ee34c5e50236fae626f251e00bf24c1045d Reviewed-by: Martin Smith <martin.smith@qt.io>
* qdoc: Document a namespace in multiple modulesMartin Smith2018-06-011-3/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | qdoc didn't handle this. This update fixes most of what was wrong, but tuning the details of the namespace reference pages might follow. We have namespace Qt as an example. Most of the elements in the Qt namespace are in QtCore, but a few functions are declared in QtGui. Before this update, qdoc used the hack of using #ifdef to remove the declarations from qtextdocument.h in QtGui and .cpp and then added them back into qtnamespace.h and .cpp in QtCore. Now that hack is no longer necessary. The functions in the Qt namespace that are declared in QtGui are documented there, but the documentation is linked to from the namespace reference page, which remains in QtCore. That is, only one \namespace command is used to document the Qt namespace, and it appears in qnamespace.qdoc where it always did, but the documentation for the Qt namespace functions declared in QtGui is now appears in qtextdocument.cpp where it belongs. This also allows qdoc to report when a namespace contains elements that are public and documented, but the namespace itself is not documented, which was not possible before this change. qdoc also reports if a namespace is documented in more than one module. That is, for example, when \namespace Qt is used in both QtCore and QtGui. Note that this change will increase the number of qdoc warnings in QtBase, but the new warnings are expacted. Change-Id: If978a59209b7b2ae90713d3ae809ae03361df72f Task-number: QTBUG-67267 Reviewed-by: Martin Smith <martin.smith@qt.io>
* qdoc: Allow defining example tags with the \meta commandTopi Reinio2017-10-111-1/+2
| | | | | | | | | | | | | | | QDoc collects example metadata that includes tags, accessible in Qt Creator's Welcome mode. These tags are automatically generated from the example title and module name. To allow writers to define additional tags to an example, \meta command can be used within \example topic: \example foo \meta {tag} {QFoo,QBar} //! Demonstrates the use of these classes Change-Id: I8f18d612567fc8e035d84663d9e2cdb953db11c6 Reviewed-by: Martin Smith <martin.smith@qt.io>
* qdoc: Further improve example file listingTopi Reinio2017-07-041-6/+10
| | | | | | | | | | | | | | | Fix a bug where '\generatelist examplefiles' with no second parameter produced an empty list, instead of listing all files. Also, no longer restrict the searching of example image files to the images/ subdirectory. All images under a project directory are now listed, except those under doc/images. Minor fixes to related QDoc documentation. Change-Id: Id4516ba2feb98466a0e893a85f85118e3d21eae2 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-09-051-1/+1
|\ | | | | | | | | | | | | Conflicts: src/qdoc/doc/qdoc-manual-markupcmds.qdoc Change-Id: I43e2d334a848397a2e619ad19aab66daff53d9b7
| * Doc: Change instances of 'OS X' to 'macOS'Topi Reinio2016-08-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | As of version 10.12 (Sierra), the name of Apple's desktop operating system will be macOS. Change all occurrences where the Mac platform is discussed to use the macro \macos (defined in the documentation configuration in qtbase), except within \code blocks in QDoc manual, where macros are not expanded. Change-Id: Ic742163948f3970d2acaa179eb02d4e0c1593bf8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Unify license header usageAntti Kokko2016-06-101-5/+5
|/ | | | | | | Updated FDL license. Change-Id: I726ee109b17070d79e19c9edcdba7780aa54b1f1 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Fix dead URLsFrank Meerkoetter2016-01-081-7/+7
| | | | | | | Link to doc.qt.io. Change-Id: I2fca0a457fad3564f0a2ce387482f922af38d4bc Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Fix broken link, dust off the \qmlsignal exampleFrank Meerkoetter2016-01-071-5/+4
| | | | | | | | This patch fixes a broken link (still pointing to Qt4.7) and also makes the example more consistent. Change-Id: I5705a367055013405c5015067567b830ab96201e Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* move qdoc back to qttoolsOswald Buddenhagen2015-10-231-0/+1594
we can do that now, as the bootstrap lib is now a properly exported module, and qmldevtools is now bootstrapped as well. this removes the abomination of a copy of the qml parser in qtbase. unfortunately qtbase/2422251ee5025a067b14b989153764ab36e43f10 is reverted, as qtdeclarative is still missing the respective change. this introduces no regression in discoverability or usability, as a full doc build already needed qttools - for qhelpgenerator. Change-Id: Ic9c4c9732ddf5998637b9e42e27939ba50b31479 Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Lars Knoll <lars.knoll@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-09 21:04:34 +0000