-
Type:
Epic
-
Status: In Progress
-
Priority:
P2: Important
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: Some future release
-
Component/s: Build tools: qdoc
-
Labels:
-
Epic Name:Improve our ability to maintain qdoc
We need to do some refactoring of the code, including the data model, we need to make qdoc testable on a unit- and acceptance testing level, and we need to implement such tests, ideally automatically executed by the CI system.
- is required for
-
QTBUG-73228 Continuously update public documentation
-
- Open
-
-
QTBUG-45725 Add a means to group methods together inside qdoc so that they are not always alphabetical
-
- Open
-
- relates to
-
QTBUG-71178 We want to ensure sufficient testing of QDoc
-
- Open
-
For Gerrit Dashboard: QTBUG-71176 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
268633,4 | QDoc: make the Config a parameter instead of a global | dev | qt/qttools | Status: MERGED | +2 | 0 |
268755,22 | QDoc: Clarify dependency between QDocCommandLineParser and Config | dev | qt/qttools | Status: MERGED | +2 | 0 |
268757,18 | QDoc: Extract helper functions from Generator to Utilities | dev | qt/qttools | Status: MERGED | +2 | 0 |
268758,4 | QDoc: Use QDocUtilities in Generator and ClangCodeParser | dev | qt/qttools | Status: ABANDONED | 0 | 0 |
268760,23 | QDoc: Further detangle QDocCommandLineParser::process() | dev | qt/qttools | Status: MERGED | +2 | 0 |
269417,25 | QDoc: Remove QDocCommandLineParser's dependency on QDocGlobals | dev | qt/qttools | Status: MERGED | +2 | 0 |
269474,14 | QDoc: Add test for QDocCommandLineParser | dev | qt/qttools | Status: MERGED | +2 | 0 |
269670,7 | QDoc: Set default Config options in Config's constructor | dev | qt/qttools | Status: MERGED | +2 | 0 |
297998,2 | QDoc: Extract helper method from generateManifestFile (refactoring) | dev | qt/qttools | Status: MERGED | +2 | 0 |
298001,2 | QDoc: Cleanup in htmlgenerator (refactoring) | dev | qt/qttools | Status: MERGED | +2 | 0 |
298497,2 | QDoc: Cleanup in htmlgenerator (refactoring) | 5.15 | qt/qttools | Status: MERGED | +2 | 0 |
298498,3 | QDoc: Extract helper method from generateManifestFile (refactoring) | 5.15 | qt/qttools | Status: MERGED | +2 | 0 |
298807,5 | QDoc: Default trivial constructors and destructors | dev | qt/qttools | Status: MERGED | +2 | 0 |
298906,2 | QDoc: Remove unused code | dev | qt/qttools | Status: MERGED | +2 | 0 |
298911,2 | QDoc: Tidy up constructor/destructor in atom | dev | qt/qttools | Status: MERGED | +2 | 0 |
298912,3 | QDoc: Clean up includes | dev | qt/qttools | Status: MERGED | +2 | 0 |
298932,2 | QDoc: Clean up unused code in codemarker.cpp | dev | qt/qttools | Status: MERGED | +2 | 0 |
298933,3 | QDoc: Get rid of unused code in CodeChunk | dev | qt/qttools | Status: MERGED | +2 | 0 |
298991,4 | QDoc: Extract DITA classes from Doc (cleanup/refactor) | dev | qt/qttools | Status: MERGED | +2 | 0 |
299151,5 | qdoc: Refactor ConfigVar | dev | qt/qttools | Status: MERGED | +2 | 0 |
299442,2 | Add tests for QDoc's configuration variable types and paths | dev | qt/qttools | Status: MERGED | +2 | 0 |
299458,2 | QDoc: Simplify if statement | dev | qt/qttools | Status: MERGED | +2 | 0 |
299668,6 | QDoc: Split Singleton from Config | dev | qt/qttools | Status: MERGED | +2 | 0 |
300686,6 | QDoc: Refactor HtmlGenerator::generateRequisites | dev | qt/qttools | Status: MERGED | +2 | 0 |
300687,6 | QDoc: Remove unused code from htmlgenerator | dev | qt/qttools | Status: MERGED | +2 | 0 |
300699,2 | QDoc: Clean up pure doc parser | dev | qt/qttools | Status: MERGED | +2 | 0 |
300701,4 | QDoc: Clean up in cppcodeparser | dev | qt/qttools | Status: MERGED | +2 | 0 |
302150,3 | QDoc: Cleanup in xmlgenerator | dev | qt/qttools | Status: MERGED | +2 | 0 |
302167,2 | QDoc: Minor cleanup in cppcodeparser | dev | qt/qttools | Status: ABANDONED | 0 | 0 |
302168,2 | QDoc: Remove remnant of deprecated command | dev | qt/qttools | Status: MERGED | +2 | 0 |
302412,2 | QDoc: Remove unused code in qdocdatabase | dev | qt/qttools | Status: MERGED | +2 | 0 |
303774,2 | QDoc: Remove yyindent | dev | qt/qttools | Status: MERGED | +2 | 0 |
304729,3 | qdoc: Remove unused function used for debugging | dev | qt/qttools | Status: MERGED | +2 | 0 |
304795,4 | QDoc: Minor cleanup in main.cpp | dev | qt/qttools | Status: MERGED | +2 | 0 |
304820,2 | QDoc: Cleanup in qdocindexfiles | dev | qt/qttools | Status: MERGED | +2 | 0 |
310213,13 | QDoc: Update expected output test | dev | qt/qttools | Status: MERGED | +2 | 0 |
312362,7 | QDoc: Remove unused conditional branch | dev | qt/qttools | Status: MERGED | +2 | 0 |
312363,7 | QDoc: Cleanup in html generator | dev | qt/qttools | Status: MERGED | +2 | 0 |
312507,2 | QDoc: Add Config::showInternal() | dev | qt/qttools | Status: MERGED | +2 | 0 |
313483,5 | QDoc: Drop ditaref remains | dev | qt/qttools | Status: MERGED | +2 | 0 |
315470,6 | QDoc: Turn QdocTagFiles into TagFileWriter to unify design | dev | qt/qttools | Status: MERGED | +2 | 0 |