summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2022-12-30 11:06:16 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-12-30 11:09:36 +0000
commit52a57f08796bea39743d439d0ebb863af68a134f (patch)
tree8175bbcbdb72cd64503a53e3b6dfc22e09c96ee5
parentc969c2b0613f60839eb932cfa6b47b8df54a5e3e (diff)
QDoc: Remove unused overload of \meta command6.3
At some point, special processing of meta content was added to make QDoc generate an entry of maintainer(s) in output. However, this hasn't seen use in the docs going back as far as _at least_ Qt 4.8. Remove this overload of the \meta command as it is unused, and adjust the relevant documentation in the QDoc manual. Fixes: QTBUG-109724 Change-Id: I9890a831f0c950c122eced62e2e1b184bda23b0b Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit db435620ab5d5420d1b59f96f413425a15c3b142) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/qdoc/doc/qdoc-manual-markupcmds.qdoc11
-rw-r--r--src/qdoc/docbookgenerator.cpp33
-rw-r--r--src/qdoc/docbookgenerator.h1
-rw-r--r--src/qdoc/generator.cpp20
-rw-r--r--src/qdoc/generator.h5
-rw-r--r--src/qdoc/htmlgenerator.cpp2
6 files changed, 4 insertions, 68 deletions
diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
index baec43947..ce542713f 100644
--- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc
@@ -3732,14 +3732,11 @@
\target meta-command
\section1 \\meta
- The \\meta command is used for adding metadata to example documentation,
- and when generating HTML output for specifying the \e maintainer(s) of a
- C++ class.
-
+ The \\meta command is used for adding metadata to example documentation.
The command has two arguments: the first argument is the name of the
- metadata attribute, and the second argument is the
- value for the attribute. Each argument should be enclosed in curly
- brackets, as shown in this example:
+ metadata attribute, and the second argument is the value for the attribute.
+ Each argument should be enclosed in curly brackets, as shown in this
+ example:
\code
/ *!
diff --git a/src/qdoc/docbookgenerator.cpp b/src/qdoc/docbookgenerator.cpp
index 8b5d22b47..9b55342d6 100644
--- a/src/qdoc/docbookgenerator.cpp
+++ b/src/qdoc/docbookgenerator.cpp
@@ -2380,37 +2380,6 @@ void DocBookGenerator::generateAlsoList(const Node *node)
}
/*!
- Generate a list of maintainers in the output
- */
-void DocBookGenerator::generateMaintainerList(const Aggregate *node)
-{
- // From Generator::generateMaintainerList.
- const QStringList sl = getMetadataElements(node, "maintainer");
-
- if (!sl.isEmpty()) {
- m_writer->writeStartElement(dbNamespace, "para");
- m_writer->writeStartElement(dbNamespace, "emphasis");
- m_writer->writeCharacters("Maintained by: ");
- m_writer->writeEndElement(); // emphasis
- newLine();
-
- m_writer->writeStartElement(dbNamespace, "simplelist");
- m_writer->writeAttribute("type", "vert");
- m_writer->writeAttribute("role", "maintainer");
- for (const QString &maintainer : sl) {
- m_writer->writeStartElement(dbNamespace, "member");
- m_writer->writeCharacters(maintainer);
- m_writer->writeEndElement(); // member
- newLine();
- }
- m_writer->writeEndElement(); // simplelist
- newLine();
-
- m_writer->writeEndElement(); // para
- }
-}
-
-/*!
Open a new file to write XML contents, including the DocBook
opening tag.
*/
@@ -2508,7 +2477,6 @@ void DocBookGenerator::generateCppReferencePage(Node *node)
generateBody(aggregate);
generateAlsoList(aggregate);
- generateMaintainerList(aggregate);
endSection();
}
@@ -4081,7 +4049,6 @@ void DocBookGenerator::generateProxyPage(Aggregate *aggregate)
generateBody(aggregate);
generateAlsoList(aggregate);
- generateMaintainerList(aggregate);
endSection();
}
diff --git a/src/qdoc/docbookgenerator.h b/src/qdoc/docbookgenerator.h
index 6f1dc0389..a8b57addc 100644
--- a/src/qdoc/docbookgenerator.h
+++ b/src/qdoc/docbookgenerator.h
@@ -124,7 +124,6 @@ private:
void generateBrief(const Node *node);
void generateAlsoList(const Node *node) override;
void generateSignatureList(const NodeList &nodes);
- void generateMaintainerList(const Aggregate *node) override;
void generateReimplementsClause(const FunctionNode *fn);
void generateClassHierarchy(const Node *relative, NodeMultiMap &classMap);
void generateFunctionIndex(const Node *relative);
diff --git a/src/qdoc/generator.cpp b/src/qdoc/generator.cpp
index ffcf7b98f..0333d438c 100644
--- a/src/qdoc/generator.cpp
+++ b/src/qdoc/generator.cpp
@@ -1114,26 +1114,6 @@ void Generator::generateDocumentation(Node *node)
}
/*!
- Generate a list of maintainers in the output
- */
-void Generator::generateMaintainerList(const Aggregate *node, CodeMarker *marker)
-{
- QStringList sl = getMetadataElements(node, "maintainer");
-
- if (!sl.isEmpty()) {
- Text text;
- text << Atom::ParaLeft << Atom(Atom::FormattingLeft, ATOM_FORMATTING_BOLD)
- << "Maintained by: " << Atom(Atom::FormattingRight, ATOM_FORMATTING_BOLD);
-
- for (int i = 0; i < sl.size(); ++i)
- text << sl.at(i) << Utilities::separator(i, sl.size());
-
- text << Atom::ParaRight;
- generateText(text, node, marker);
- }
-}
-
-/*!
Extract sections of markup text surrounded by \e qmltext
and \e endqmltext and output them.
*/
diff --git a/src/qdoc/generator.h b/src/qdoc/generator.h
index 77b894416..5a6e8ee3d 100644
--- a/src/qdoc/generator.h
+++ b/src/qdoc/generator.h
@@ -126,11 +126,6 @@ protected:
virtual void generateCollectionNode(CollectionNode *, CodeMarker *) {}
virtual void generateGenericCollectionPage(CollectionNode *, CodeMarker *) {}
virtual void generateDocumentation(Node *node);
- virtual void generateMaintainerList(const Aggregate *node, CodeMarker *marker);
- virtual void generateMaintainerList(const Aggregate *node)
- {
- generateMaintainerList(node, nullptr);
- };
virtual bool generateQmlText(const Text &text, const Node *relative, CodeMarker *marker,
const QString &qmlName);
virtual bool generateQmlText(const Text &text, const Node *relative)
diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp
index 9c9e4616c..781cbf677 100644
--- a/src/qdoc/htmlgenerator.cpp
+++ b/src/qdoc/htmlgenerator.cpp
@@ -1130,7 +1130,6 @@ void HtmlGenerator::generateCppReferencePage(Aggregate *aggregate, CodeMarker *m
generateBody(aggregate, marker);
out() << "</div>\n";
generateAlsoList(aggregate, marker);
- generateMaintainerList(aggregate, marker);
generateExtractionMark(aggregate, EndMark);
}
@@ -1230,7 +1229,6 @@ void HtmlGenerator::generateProxyPage(Aggregate *aggregate, CodeMarker *marker)
generateBody(aggregate, marker);
out() << "</div>\n";
generateAlsoList(aggregate, marker);
- generateMaintainerList(aggregate, marker);
generateExtractionMark(aggregate, EndMark);
}