Details
-
Task
-
Resolution: Unresolved
-
P3: Somewhat important
-
None
-
None
-
None
-
e54971170 (dev), e5912919a (6.6), 25575b905 (6.5), f2e622a75 (dev)
-
DaVinci 88
Description
qdoc could warn if the string passed to \deprecated doesn't end with a dot, as this will lead to incorrect grammar in the generated documentation.
E.g.
/*!
\deprecated [6.9] Use setTimeZone() instead
[...]
*/
void QDateTime::setTimeSpec(Qt::TimeSpec spec)
generates
void QDateTime::setTimeSpec(Qt::TimeSpec spec)
This function is deprecated since 6.9. We strongly advise against using it in new code.
Use setTimeZone() instead
The last sentence looks out of place, as it doesn't end with a end-of-sentence marker. Anyhow, that is not obvious in qdoc.
Attachments
Issue Links
- is blocked by
-
QTBUG-114157 qdoc: Consolidate and emphasize \deprecated messages for QML and C++
-
- Open
-
- resulted from
-
-
- Open
-
Gerrit Reviews
| For Gerrit Dashboard: QTBUG-117470 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 507265,10 | WIP: QDoc: Insert missing full stop for briefs | dev | qt/qttools | Status: NEW | -2 | 0 |
| 507264,2 | QDoc: Refactor XmlGenerator::rewritePropertyBrief | dev | qt/qttools | Status: MERGED | +2 | 0 |
| 507670,3 | QDoc: Refactor XmlGenerator::rewritePropertyBrief | 6.6 | qt/qttools | Status: MERGED | +2 | 0 |
| 507887,2 | Doc: Add missing full stop to briefs | dev | qt/qtbase | Status: MERGED | +2 | 0 |
| 508506,3 | QDoc: Refactor XmlGenerator::rewritePropertyBrief | 6.5 | qt/qttools | Status: MERGED | +2 | 0 |