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

Cannot document private virtual (abstract) methods with QDoc

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P3: Somewhat important P3: Somewhat important
    • None
    • 5.8.0
    • Build tools: qdoc
    • 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.

        For Gerrit Dashboard: QTBUG-58805
        # Subject Branch Project Status CR V

            paulwicking Paul Wicking
            resurr3ction Michael Vlach
            Votes:
            2 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: