Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-85565

Adapt Qdoc to use the new property system

XMLWordPrintable

    • Icon: User Story User Story
    • Resolution: Done
    • Icon: P2: Important P2: Important
    • 6.0.0
    • 6.0.0
    • Build tools: qdoc
    • None
    • Da Vinci sprint 14, Da Vinci sprint 15, Da Vinci sprint 16, Da Vinci sprint 17
    • 82384d23378ca8277d0a228c1f343d7d89912edb (qt/qttools/dev)

      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:

      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().

       

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            treinio Topi Reiniö
            veshivas Venugopal Shivashankar
            Paul Wicking Paul Wicking
            Tino Pyssysalo Tino Pyssysalo
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes