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

qthelp documentation missing examples, inheritance relationships

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P2: Important
    • 5.2.0
    • 5.0.0, 5.1.1, 5.2.0 Beta1
    • Documentation
    • None
    • Fedora 19
    • 290b28aeda46fa31fde6310e563de3a4736b84c1 (qttools)

    Description

      Looking at the Qt help framework documentation in 5.x releases I've noticed following small issues:

      1) The first example box is empty:

      After specifying all relevant information in this file, it needs to be compiled by calling: <nothing>

      (e.g. http://doc-snapshot.qt-project.org/qt5-stable/qthelp-framework.html)

      That means that the reader actually does not learn what command to use to compile Qt help files.

      2) The QHelpEngine widgets (which are returned by QHelpEngine methods) seem to inherit QWidget. But the documentations says that QHelpContentWidget and QHelpIndexWidget don't inherit from anything.

      E.g.: http://doc-snapshot.qt-project.org/qt5-stable/qhelpindexwidget.html, http://doc-snapshot.qt-project.org/qt5-stable/qhelpcontentwidget.html

      3) The qt help index page lists

      CONFIG += help

      but qmake reports this construct as deprecated - it suggests instead:

      QT += help

      The class documentation pages also use QT += help.

      (e.g. http://doc-snapshot.qt-project.org/qt5-stable/qthelp-index.html)

      Attachments

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

        Activity

          People

            treinio Topi Reiniƶ
            gsauthof Georg Sauthoff
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes