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

Find solution for ambiguous links to section titles

    XMLWordPrintable

    Details

    • Sprint:
      DaVinci 56
    • Commits:
      a8cb221c7b (qt/qttools/dev) 38d0517f8b (qt/qttools/6.4) 38d0517f8b (qt/tqtc-qttools/6.4) a8cb221c7b (qt/tqtc-qttools/dev)

      Description

      qdoc does generate implicit anchors for all section titles. When there are multiple anchors for a link, local anchors are preferred.

      This is convenient, but often leads to 'wrong' links being generated that are hard to detect. In particular, an innocent change that adds a section can break the links in otherwise unrelated places.

      Let's explore ways to fix this.

      • Should qdoc stop generating anchors for section titles?
      • Should \externalpage, module names ... take precedence over local sections?
      • Should there be a way to be explicit about external page, i.e. \l[EXTERNAL] {Squish}

        ?

      • Should qdoc warn about ambiguous links, forcing the user to make links explicit?

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              treinio Topi Reiniö
              Reporter:
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes