Details
-
User Story
-
Resolution: Done
-
P2: Important
-
None
-
None
-
DaVinci 56
-
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
- is duplicated by
-
QTBUG-104136 Doc: Fix 'qmake' links
- Closed
- resulted from
-
QTBUG-103250 Link to ScrollBar's size property is wrong
- Closed
-
QTBUG-104138 Doc: Wrong link to 'Squish'
- Closed
For Gerrit Dashboard: QTBUG-104137 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
415535,5 | qdoc: Down-prioritize linking to section titles | dev | qt/qttools | Status: MERGED | +2 | 0 |
416020,2 | qdoc: Down-prioritize linking to section titles | 6.4 | qt/qttools | Status: MERGED | +2 | 0 |