summaryrefslogtreecommitdiff
path: root/src/qdoc/doc/examples
Commit message (Collapse)AuthorAgeFilesLines
* QDoc: Move QDoc source files under a further "qdoc" directoryLuca Di Sera2023-04-129-575/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | QDoc development under the "qttools" repository is currently performed under the "src/qdoc" directory, which contains all source files and directories relevant to QDoc as direct children. Due to a slow restructuring of how QDoc works, what its dependencies are and certain possible architectural changes, the infrastructure that is expected to be required for the development of QDoc might increase. Some of that infrastructure, which might require some custom effort, is expected to be developed as "independent" "library-like" sub-projects, which QDoc depends on. Albeit developed "independently", such infrastructure would be developed specifically for QDoc and thus should live "adjacent" to it. To allow such a structure a new "qdoc" directory was added under the "src/qdoc" directory. All source files and directory that were previously children of the "src/qdoc" directory were moved under the new "qdoc" directory. This preserves the space for QDoc-related elements and the relative project structure while allowing some space for "adjacent" projects that are intended for QDoc specifically. To support the change, a new "CMakeLists.txt" file was introduced under "src/qdoc", which dispatches to the "CMakeLists.txt" file in the new "src/qdoc/qdoc" directory. QDoc is only built when certain dependencies are found. This is supported through the use of Qt features at the CMake level. The "CMakeLists.txt" file in "src", thus dispatched to the "src/qdoc" directory only when the required features were found. As "independent", "library-like", entities might not have the same requirements as QDoc, the "CMakeLists.txt" file in "src" was modified to always dispatch to the "src/qdoc" directory while the features-check was moved to the new "CMakeLists.txt" files in "src/qdoc", so as to allow non-QDoc but QDoc-specific project to have an independent configuration for building. Certain test projects in "test/auto/qdoc/" depends on QDoc-specific source-files to generate their CMake targets. Those dependencies were generally specified as relative paths. The additional level in the directory structure invalidated the paths and, hence, the relevant "CMakeLists.txt" files for those projects were modified to correctly refer to the new directory structure. Change-Id: I50c7106614428753544eaba5091e1e44d48fd31d Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Remove usages of the second argument of a "\page" commandLuca Di Sera2022-09-081-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | The "\page" command for QDoc, used to construct a standalone documentation page in the output documentation of a project, was able to take a second argument, apart from the first argument representing the name for the generated documentation page, that roughly represented the type of the page that was to be generated. This second argument was not actually used by QDoc, such that it had no meaningful effect. QDoc was recently modified to not support this second argument, internally, and officially removed its use. For technical legacy reason, QDoc will still support the usage of a second argument for a "\page" command, albeit it will do nothing, as before. To avoid confusion for future readers who might not be aware of the history of the "\page" argument and that will not find an explanation in QDoc's documentation anymore, the usages of the second argument in "\page" commands are now removed. Change-Id: I084eb315a17562c9f43e8c43a4af218968d62fbf Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Use SPDX license identifiersLucie Gérard2022-05-195-132/+10
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Task-number: QTBUG-67283 Change-Id: I5335388c0472b0ee554234fc7eca60769e504660 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: QDoc Manual: Refer to the tool as 'QDoc' consistentlyTopi Reinio2020-04-201-2/+2
| | | | | | | | 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 manual: fix typoPaul Wicking2019-08-211-1/+1
| | | | | Change-Id: Id45f132ea88d08eef58bc3c0ee7dad150510e8c4 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'origin/5.12' into devLiang Qi2019-01-187-644/+8
|\ | | | | | | | | | | | | | | Conflicts: .qmake.conf src/assistant/help/qhelpcollectionhandler.cpp Change-Id: If1408a5893bc9ade9088e01c00aab695eff131aa
| * Move QML documentation example to QDoc testsPaul Wicking2018-12-236-630/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The import and types contained in the example ends up in reference overviews. This causes confusion among users. The example serves its purpose better as a QML project to generate documentation from as tests for QDoc. Moving the example to tests/auto/qdoc will exclude it from ending up in the online docs. This will also keep the git history cleaner than readding the same files as a separate commit later on. Task-number: QTBUG-43904 Change-Id: I6e080d50319f235916cbd8e1dda3da7dba1dccd1 Reviewed-by: Kai Koehne <kai.koehne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| * Doc: Update minimum qdocconfPaul Wicking2018-12-191-14/+8
| | | | | | | | | | | | | | Turn the minimum qdocconf into copypasta material. Change-Id: I923831701f60f5a95b7708326b5bfd669b424edb Reviewed-by: Martin Smith <martin.smith@qt.io>
* | Doc: Update instructions and example for documenting QML enumsLeena Miettinen2018-09-211-8/+6
|/ | | | | | | | | The \value command can now be used within a \qmlproperty command of the type "enumeration" to document the enum values. Change-Id: I63739b88399d8551082168d85a731f908a761338 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Add missing dotsPaul Wicking2018-06-193-3/+3
| | | | | | Task-number: QTBUG-68933 Change-Id: I32122f9c771b12f1ea4cb3c8e405c30bf2bf4d41 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* qdoc: Add file extensions to minimum.qdocconfMartin Smith2017-11-111-0/+4
| | | | | | | | minimum.qdocconf is changed to include fileextensions.qdocconf. Task-number: QTBUG-62060 Change-Id: If50f7f87813fae0c2d52ffc0a812bfadda1a203b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-06-291-1/+1
|\ | | | | | | | | | | | | Conflicts: src/assistant/assistant/doc/src/assistant-manual.qdoc Change-Id: I136caf5f26eff4d1c2574459b8dff9937c2c372d
| * Use \note commandKai Koehne2016-06-211-1/+1
| | | | | | | | | | Change-Id: Icf7b356ea04989525313e53c883cb8d4dec28762 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* | Unify license header usagev5.7.05.7.0Antti Kokko2016-06-103-9/+39
| | | | | | | | | | | | | | Updated BSD license. Change-Id: Ie2521f94a2e8ed423f989e902e5eb88512814f71 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Unify license header usageAntti Kokko2016-06-105-25/+25
| | | | | | | | | | | | | | Updated FDL license. Change-Id: I726ee109b17070d79e19c9edcdba7780aa54b1f1 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Updated license headers and license testsAntti Kokko2016-06-102-34/+24
|/ | | | | | | | | | | | | From Qt 5.7 -> tools & applications are licensed under GPL v3 with some exceptions, see http://blog.qt.io/blog/2016/01/13/new-agreement-with-the-kde-free-qt-foundation/ Updated license headers to use new GPL-EXCEPT header instead of LGPL21 one (in those files which will be under GPL 3 with exceptions) License header tests also updated to match current headers. Change-Id: Ia6bdacaa3c5bbc9d31334e1a0cabfe502a484dc4 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* move qdoc back to qttoolsOswald Buddenhagen2015-10-2315-0/+1311
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>