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

Make inherited API more visible in the documentation of derived types

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • Not Evaluated
    • None
    • None
    • Documentation
    • None

    Description

      Judging from interactions in our online communities, users often miss API that is available in a derived type. We have the "Inherits: Foo" bit at the top of each page, but that's easy to miss. It would be useful to somehow incorporate inherited API in the "table" at the top of the page.

      Some ideas of how we could do this:

      Include inherited API directly in the list, but differentiate it

      Although this would easily get too crowded and noisy when you consider how many items there would be in the list from e.g. Item and Control. So even better would be to...

      Include inherited API in the list as a collapsed section that can be expanded or a link that can be clicked

      If it's a collapsed section, clicking it would make it look similar to the screenshot above. If it's a link that can be clicked, it would take the user to the relevant section of the base type's documentation.

      Attachments

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

        Activity

          People

            docteam Qt Documentation Team
            mitch_curtis Mitch Curtis
            Votes:
            3 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes