diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-10-24 14:05:46 +0200 |
---|---|---|
committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-10-25 09:14:48 +0000 |
commit | 46776ca0ab7ae212e928de64a2819104d8789c3a (patch) | |
tree | 5fa44ce53e1bf0900bdcd44848d82f5d94014d9d | |
parent | 9b50d79a024155b491d6c09a829b3e382823003c (diff) |
Shiboken: QtDoc: Fix how brief and class tags are handled
- The brief attribute of a page tag should be
ignored to avoid briefs appearing twice.
- The class ref pages should use the
.. currentmodule:: rst directive instead of the
.. module::.
Change-Id: Iac205d60f79db49eb8c69a2593f09fb206a5b1a3
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
-rw-r--r-- | sources/shiboken2/generator/qtdoc/qtdocgenerator.cpp | 6 |
1 files changed, 1 insertions, 5 deletions
diff --git a/sources/shiboken2/generator/qtdoc/qtdocgenerator.cpp b/sources/shiboken2/generator/qtdoc/qtdocgenerator.cpp index 3b6d1c870..86abf21b0 100644 --- a/sources/shiboken2/generator/qtdoc/qtdocgenerator.cpp +++ b/sources/shiboken2/generator/qtdoc/qtdocgenerator.cpp @@ -1236,10 +1236,6 @@ void QtXmlToSphinx::handlePageTag(QXmlStreamReader &reader) : writeEscapedRstText(m_output, fullTitle); m_output << endl << Pad('*', size) << endl << endl; - - const QStringRef brief = reader.attributes().value(briefAttribute()); - if (!brief.isEmpty()) - m_output << escape(brief) << endl << endl; } void QtXmlToSphinx::handleTargetTag(QXmlStreamReader &reader) @@ -1625,7 +1621,7 @@ void QtDocGenerator::generateClass(QTextStream &s, GeneratorContext &classContex m_docParser->setPackageName(metaClass->package()); m_docParser->fillDocumentation(const_cast<AbstractMetaClass*>(metaClass)); - s << ".. module:: " << metaClass->package() << endl; + s << ".. currentmodule:: " << metaClass->package() << endl; QString className = getClassTargetFullName(metaClass, false); s << ".. _" << className << ":" << endl << endl; |