-
Bug
-
Resolution: Fixed
-
P3: Somewhat important
-
None
-
5.8.0
-
77b014b3a (dev), 2822ab16c (dev), 4b94d528c (dev), d9f862fe3 (dev), 595e95f22 (dev), 4b57aee41 (dev), e81bfcc25 (dev), e60139313 (dev)
-
DaVinci 123, DaVinci 124
There are two similar use cases for private virtual methods.
1) Abstract private virtual methods
Requires documentation so that it informs the subclasses what the method is expected to do. Se 2) for why declaring them private is useful.
2) Non-abstract private virtual methods
Non-absract private virtual methods are useful for preventing subclasses to call the base implementation directly. The documentation might be useful here to inform potential subclasses what the base implementation does and how they could override that behaviour.
Currently QDoc omits the private members and does not provide any means to expose them in the documentation. While this is sensible for regular methods it is a problem for virtual methods.
I suggest something similar to command \internal just in reverse. What would normally be considered internal and skipped would be exposed.
- relates to
-
QTBUG-99553 qdoc: Hidden friends not visible if declared as private
-
- Closed
-
-
QTBUG-114877 QDoc doesn't catch private pure virtual methods
-
- Closed
-
-
QTBUG-63977 [QDOC] Add a setting to document private class members
-
- Closed
-
- resulted in
-
QTBUG-140077 QDoc: Refactor private node inclusion logic to eliminate code duplication
-
- Closed
-
For Gerrit Dashboard: QTBUG-58805 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
672128,2 | QDoc: Add includeprivate configuration option | dev | qt/qttools | Status: MERGED | +2 | 0 |
672129,2 | QDoc: Implement includeprivate section building logic | dev | qt/qttools | Status: MERGED | +2 | 0 |
672130,2 | QDoc: Remove redundant filtering in output generators | dev | qt/qttools | Status: MERGED | +2 | 0 |
672131,3 | QDoc: Add test for private member documentation | dev | qt/qttools | Status: MERGED | +2 | 0 |
672132,3 | QDoc: List private variables in C++ class summaries | dev | qt/qttools | Status: MERGED | +2 | 0 |
672133,3 | QDoc: Honor includeprivate* settings in summary links | dev | qt/qttools | Status: MERGED | +2 | 0 |
672142,10 | QDoc: Don’t force private access for \internal nodes | dev | qt/qttools | Status: MERGED | +2 | 0 |
672302,2 | QDoc: Filter 'undocumented' warnings for private members | dev | qt/qttools | Status: MERGED | +2 | 0 |