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

Inclusion of inherited functions result in very cluttered and nonsensical class refs

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P1: Critical
    • 5.0.0 RC 1
    • 5.0.0 Beta 1
    • Documentation
    • None
    • befde564549ba866076b35c94580300dfa278fcf

    Description

      Background
      Inherited member functions used to be excluded from class refs. However, this is no longer the case. I'm guessing this is either:

      • Done so that users can see all available functions, without having to read an ancestor's class ref, or
      • A bug in QDoc

      There are some bad side-effects:

      Issues

      1. Many benefits of convenience classes are lost – they now look as complicated and intimidating as their abstract ancestors
        • E.g. Contrast the Qt 5 with the Qt 4.8 versions of the QStringListModel docs. The latter is much easier to read and understand than the former
      2. Nonsensical listings now exist
        • E.g. QStringListModel lists functions such as insertColumn(). "Columns" have no meaning in a list model
      3. SOME constructors and destructors of ancestor classes are shown too
        • E.g. QCommandLinkButton shows destructors for QAbstractButton and QPaintDevice (but strangely, not for QPushButton)

      Suggestion
      Revert to old Qt 4.8 doc-generation behaviour, so that it's easier to see which functions were introduced or reimplemented by a subclass

      Attachments

        Issue Links

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

          Activity

            People

              gbk Martin Smith (Qt)
              jksh Sze Howe Koh
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes