diff options
author | Topi Reinio <topi.reinio@qt.io> | 2023-03-17 10:26:23 +0000 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2023-03-22 13:10:31 +0000 |
commit | b744b634f792577e1ec467801c500b84bebc995d (patch) | |
tree | a928ea51b130ccfd48edbbe047e383abbc2b9725 | |
parent | 757c3d8dd9e6528926e8765d91ede29b8523e466 (diff) | |
download | qttools-b744b634f792577e1ec467801c500b84bebc995d.tar.gz |
qdoc: Fix auto-generated \since note for \enum documentation
Drop the wording 'modified in x.y' from auto-generated note for \enum
with a \since. Modifying an enum is now handled with \value since-clauses,
and updating the \since version for the parent \enum would be incorrect.
Fixes: QTBUG-108246
Change-Id: I6f32d14d108a1a71d0c0efc185f390617f0ba3cb
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
-rw-r--r-- | src/qdoc/docbookgenerator.cpp | 6 | ||||
-rw-r--r-- | src/qdoc/generator.cpp | 6 |
2 files changed, 4 insertions, 8 deletions
diff --git a/src/qdoc/docbookgenerator.cpp b/src/qdoc/docbookgenerator.cpp index 721bbd945..5f370c954 100644 --- a/src/qdoc/docbookgenerator.cpp +++ b/src/qdoc/docbookgenerator.cpp @@ -2314,10 +2314,8 @@ bool DocBookGenerator::generateSince(const Node *node) // From Generator::generateSince. if (!node->since().isEmpty()) { m_writer->writeStartElement(dbNamespace, "para"); - m_writer->writeCharacters("This " + typeString(node) + " was introduced"); - if (node->nodeType() == Node::Enum) - m_writer->writeCharacters(" or modified"); - m_writer->writeCharacters(" in " + formatSince(node) + "."); + m_writer->writeCharacters("This " + typeString(node) + " was introduced in "); + m_writer->writeCharacters(formatSince(node) + "."); m_writer->writeEndElement(); // para newLine(); diff --git a/src/qdoc/generator.cpp b/src/qdoc/generator.cpp index 3e9b26bac..3d1f420ee 100644 --- a/src/qdoc/generator.cpp +++ b/src/qdoc/generator.cpp @@ -1165,10 +1165,8 @@ void Generator::generateSince(const Node *node, CodeMarker *marker) { if (!node->since().isEmpty()) { Text text; - text << Atom::ParaLeft << "This " << typeString(node) << " was introduced "; - if (node->isEnumType()) - text << "or modified "; - text << "in " << formatSince(node) << "." << Atom::ParaRight; + text << Atom::ParaLeft << "This " << typeString(node) << " was introduced in " + << formatSince(node) << "." << Atom::ParaRight; generateText(text, node, marker); } } |