Details
-
User Story
-
Resolution: Done
-
P2: Important
-
6.0.0
-
None
-
Da Vinci sprint 14, Da Vinci sprint 15, Da Vinci sprint 16, Da Vinci sprint 17
-
82384d23378ca8277d0a228c1f343d7d89912edb (qt/qttools/dev)
Description
QDoc uses the Q_PROPERTY macro to capture the getter, setter, and value change signal info., and append it to the property documentation. With the new system, the clangqdocparser should be able to capture all the details about the QProperty<T> declarations, but the docpaser might have to be taught to use this info. in a sensible way.
Here are some useful links:
- https://web.microsoftstream.com/video/81ae2b98-f177-4532-ab5f-0216dcf70647 - link to the video recording where the new property system is described.
- Related gerrit changes that could be used as a reference:
The getter will always be value() irrespective of the property type, and the setter is a simple assign statement using the = operator. We could just append this info. to the documentation for every QProperty<T> instance found.
The value change notification signal will always be onValueChanged and the developer must register a callback using the QProperty::subscribe method to get notified:
template <typename Functor> QPropertyChangeHandler<Functor> QProperty::subscribe(Functor f)
For more info., see the documentation for QProperty::subscribe().
Attachments
Issue Links
- is duplicated by
-
QTBUG-85587 qdoc needs to handle new properties
- Closed
For Gerrit Dashboard: QTBUG-85565 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
309792,5 | qdoc: Add support for bindable properties | dev | qt/qttools | Status: MERGED | +2 | 0 |
309793,12 | qdoc: Test the C++ property macros in QDoc's generatedoutput autotest | dev | qt/qttools | Status: MERGED | +2 | 0 |