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

QDoc's "Example Manifest Files" page violates our Examples Guidelines

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P3: Somewhat important
    • 6.6.0
    • 6.5.0
    • Build tools: qdoc
    • None
    • All
    • da8244d82 (dev)
    • DaVinci 79

    Description

      The "Example Manifest Files" page uses as its illustration an out-of-date version of the "analog clock window" example. This page is linked from the recent Example Guideline page on the public wiki; those guidelines discourage use of "Example" in the names of examples, but the out-of-date version used in the illustration does so.

      (The illustration appears to be based on qtbase/examples/widgets/doc/src/analogclock.qdoc which smd has recently fixed to conform to the guidelines, in qtbase commit fd65f709748a7026428cc3a8828784cbb8421a03. This may contain other changes that should be reflected in the illustration based on this example.)

      The source for the out-of-date documentation appears to be qttools/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc – that needs an update as part of our examples revamp, if only to avoid having our own guidelines reference documentation that violates them …

      Attachments

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

        Activity

          People

            paulwicking Paul Wicking
            Eddy Edward Welbourne
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes