summaryrefslogtreecommitdiffstats
path: root/src/qdoc/doc/config/qdoc.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* QDoc: Move QDoc source files under a further "qdoc" directoryLuca Di Sera2023-04-121-59/+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 unsupported customFiltersKai Köhne2021-08-251-4/+0
| | | | | | Task-number: QTBUG-95987 Change-Id: I48402b78c1055919d6db352d5cb31bdaeecc43d5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QDoc: Drop doc dependency to qtbase for QDoc manualPaul Wicking2021-06-251-2/+1
| | | | | | | | | | | * Drop imagedir external to the qttools repo, as this causes problems for single module integrations. * Add images that were used from qtbase. * Remove outdated image and replace its use with an updated one. Task-number: QTBUG-83851 Change-Id: I0c740fdfa8ba013457c75adf0bca0138ce501d4d Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Enforce zero documentation warning policyTopi Reinio2020-11-071-0/+2
| | | | | | Task-number: QTBUG-78069 Change-Id: I3809c090fd46fefeefaad003d648f9d9db56f8f5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix documentation warnings for qttoolsTopi Reinio2020-11-071-1/+0
| | | | | | | | Fix linking failures caused by the removal of Qt Assistant, and fix usage of obsolete/removed functionality. Change-Id: Iaefbebcc1371b41429377dc8219101bda9fbf79a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* QDoc manual: Do not reference or rely on qtimageformatsPaul Wicking2020-10-291-1/+0
| | | | | | | Removes a QDoc warning in qttools. Change-Id: I78efdd90969df214961f96d386ef268a15ad6156 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.15' into devTopi Reinio2020-05-291-0/+2
|\ | | | | | | Change-Id: I8c1fc05462e1b99b16d52e4f43b2b4b1aa645152
| * Doc: QDoc Manual: Refer to the tool as 'QDoc' consistentlyTopi Reinio2020-04-201-0/+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>
* | Doc: Fix documentation warningsTopi Reinio2020-05-201-7/+1
|/ | | | | | | Fix documentation warnings for all modules contained in qttools. Change-Id: I787de084ef5723e9a27a525cfcd3858caa2f1c94 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | Task-number: QTBUG-74391 Change-Id: Iced8f21af188b249a0ac59f71fa2fb7cb6a52869 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Clear 'moduleheader' for tool manualsTopi Reinio2019-05-031-0/+1
| | | | | | | | | These manuals contain no C++ API documentation, and there is no associated module headers - clearing the moduleheader variable in documentation configuration stops QDoc from warning about them. Change-Id: I71b8ec81800025d9de18b83871a9881c1246f153 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Purge xmlpattern dependency from qttools documentationAlex Blasche2019-04-011-2/+1
| | | | | | | The qtxmlpattern will become obsolete in Qt 5.13. Change-Id: Id5e67d4681f3fde9d09705aea3377727db71e964 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix issues in QDoc Manual documentationTopi Reinio2016-01-191-14/+7
| | | | | | | | | | | | | | | | This commit partially reverts 23fc55c4bbf3cf334ff33f1b7816c35fdc67fd93 - adding example directories from outside the module boundaries caused multiple warnings. Instead, copy-paste the required code snippet directly into the source documentation. Additionally, in qdoc.qdocconf, - Remove obsolete 'imagedirs' path - Remove obsolete dependencies - Fix filter attributes - Use up-to-date selectors for QHP Change-Id: Ic2836e1e2e1da6b4aebcd0250af25e2b40cce196 Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
* qdoc-doc: Add some paths needed by qdoc-manual-markupcmds.qdocEdward Welbourne2016-01-041-2/+4
| | | | | | | | They're both in qtbase, but I'm hoping we can get away with assuming it's checked out alongside qttools. Change-Id: Ic9cde061f2065acf0a5199bf5974a3b17efe6e2e Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* move qdoc back to qttoolsOswald Buddenhagen2015-10-231-0/+72
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>