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

Doc: Remove use of defunct QDoc command "\tableofcontents"

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P2: Important
    • 6.8.0
    • 6.7
    • Documentation
    • eb1eee59b (dev), 33f2069c9 (6.8), 624eccf25 (dev), 3453d1fe5 (dev), c6894fc99 (6.8), f77131749 (6.8), 3437b0475 (dev), 0cc71529d (dev), d90c0ed49 (dev), c39aa15c0 (dev), ca3e62f53 (dev), 7c112eb33 (6.8), 48328e514 (6.8), 5f144de39 (6.8), ace9283eb (6.8)
    • DaVinci 102

    Description

      Across Qt's source, the defunct QDoc command `\tableofcontents` is sometimes preceded by leading text, e.g. "Topics:", which makes it appear as if something is missing from the output. See for example how https://doc.qt.io/qt-6/qstyle.html#details ends with "Topics:", indicating that it should be followed by the ToC as indicated by the use of the command:
      (https://github.com/qt/qtbase/blob/dev/src/widgets/styles/qstyle.cpp#L133). However, this ToC isn't generated by QDoc as the command has been made redundant.

      Remove the ~80 uses of \tableofcontents across modules, and ensure that surrounding context still makes sense for the reader.

      Attachments

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

        Activity

          People

            paulwicking Paul Wicking
            dourouc05_ Thibaut Cuvelier
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: