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

QDoc: Auto-qualify unqualified function names in \overload commands

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Fixed
    • Icon: P3: Somewhat important P3: Somewhat important
    • 6.11.0 FF
    • None
    • Build tools: qdoc
    • 669327abd (dev), f3d5386fa (dev), 41e80d398 (6.10)
    • DaVinci 122

      The \overload command requires fully qualified function names (e.g., \overload QMenu::addAction()) to generate working links. Unqualified names (e.g., \overload addAction()) fails to resolve, creating missing links in generated documentation.

      We could implement automatic qualification of unqualified overload targets using the parent class as context. This would allow automatic lookup (convenient for documentation authors) but we'd still allow fully qualified names, so both syntaxes should work, providing backwards compatibility. In other words, this would improve the documentation authoring experience by reducing verbosity while maintaining link functionality.

      As there seems to be a fair amount of \overload someFunction() in Qt's documentation, this would improve the generated content without the need to fix them all in source.

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

            paulwicking Paul Wicking
            paulwicking Paul Wicking
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are 2 open Gerrit changes