-
Suggestion
-
Resolution: Fixed
-
P3: Somewhat important
-
None
-
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.
- relates to
-
QTBUG-138586 Clarify behavior of \overload if main method has arguments
-
- Closed
-
- resulted from
-
QTBUG-138887 [REG 5.13 → 5.14] \overload lastIndexOf() in qstring.cpp renders lastIndexOf() as a non-link
-
- Closed
-
- resulted in
-
QTBUG-138890 DocBookGenerator lacks OverloadNote support
-
- Closed
-