summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc/qdoc-manual-cmdindex.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* qdoc: properly implement \typealias commandTopi Reinio2020-04-231-0/+1
| | | | | | | | | | | | | | | | | | \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>
* QDoc: Add warning to use of \contentspage commandv5.15.0-beta2Paul Wicking2020-03-111-2/+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>
* qdoc: Remove the \indexpage commandMartin Smith2018-12-031-1/+0
| | | | | | | | | The \indexpage command is no longer used. This update removes it from qdoc and from the qdoc manual. Change-Id: I7ac0cdc2d7fffc91dda01024740478e7da5570f0 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Remove support for \compat commandMartin Smith2018-06-011-1/+0
| | | | | | | | | The \compat command is no longer needed in QDoc, and the code that supports it makes some parts of QDoc needlessly complex. This update removes it, along with the documentation for it in the QDoc manual. Change-Id: I249b571e24ff8c3530d1ae5dbb4fff9186dba49d Reviewed-by: Martin Smith <martin.smith@qt.io>
* qdoc: Remove chapter and part commandsMartin Smith2017-08-101-2/+0
| | | | | | | | These commands are not used anywhere, and they cause qdoc to generate illegal html code, so they are removed. Change-Id: I39b670a9691221854a78ea5c332c67ea758199ee Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: QDoc manual: Document \badcodeTopi Reinio2017-01-051-0/+1
| | | | | | Change-Id: Iffbf809261a2ac572aa83ca5aaddb3d6258221ac Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: QDoc manual: clean up command indexTopi Reinio2017-01-051-6/+7
| | | | | | | | | | | Fix typos and formatting, remove unused \span commands and remarks of items introduced 5 years ago as being 'New'. Also list the \qml command in the command index, and remove a couple of obsolete statements. Change-Id: Iaa7a81889f30e08ea8299bc0e1848c8472efa7e1 Reviewed-by: Martin Smith <martin.smith@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>
* move qdoc back to qttoolsOswald Buddenhagen2015-10-231-0/+156
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>