AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qdoc: The \wrapper command is added

Browse Source 
If \wrapper appears in a \class comment or a
\qmltype comment, qdoc will not print warnings
when it finds public members of the class or the
QML type that are not documented.

The \wrapper command is added to several
opengl classes. This reduces the number of
qdoc warnings by several thousands.

Task-number: QTBUG-30755
Change-Id: Iba1eebc1590ccf54100e40fe91423240c1b3d09d
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Martin Smith 2013-04-30 15:46:20 +02:00 committed by The Qt Project
parent e4471e72b2
commit 36b7c3cd2b
28 changed files with 56 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/gui/opengl/qopenglfunctions_1_0.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_1_0
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_1_0 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_1_1.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_1_1
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_1_1 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_1_2.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_1_2
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_1_2 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_1_3.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_1_3
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_1_3 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_1_4.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_1_4
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_1_4 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_1_5.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_1_5
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_1_5 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_2_0.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_2_0
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_2_0 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_2_1.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_2_1
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_2_1 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_3_0.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_3_0
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_3_0 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_3_1.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_3_1
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_3_1 class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_3_2_compatibility.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_3_2_Compatibility
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_3_2_Compatibility class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_3_2_core.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_3_2_Core
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_3_2_Core class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_3_3_compatibility.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_3_3_Compatibility
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_3_3_Compatibility class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_3_3_core.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_3_3_Core
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_3_3_Core class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_0_compatibility.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_0_Compatibility
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_0_Compatibility class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_0_core.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_0_Core
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_0_Core class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_1_compatibility.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_1_Compatibility
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_1_Compatibility class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_2_compatibility.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_2_Compatibility
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_2_Compatibility class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_2_core.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_2_Core
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_2_Core class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_3_compatibility.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_3_Compatibility
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_3_Compatibility class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_4_3_core.cpp
View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_4_3_Core
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_4_3_Core class provides all functions for this version and profile of OpenGL.
\sa QAbstractOpenGLFunctions

1
src/gui/opengl/qopenglfunctions_es2.cpp
View File

@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
\class QOpenGLFunctions_ES2
\inmodule QtGui
\since 5.1
\wrapper
\brief The QOpenGLFunctions_ES2 class provides all functions for OpenGL ES 2
\sa QAbstractOpenGLFunctions

7
src/tools/qdoc/codeparser.cpp
View File

@ -70,6 +70,7 @@ QT_BEGIN_NAMESPACE
#define COMMAND_SUBTITLE Doc::alias(QLatin1String("subtitle"))
#define COMMAND_THREADSAFE Doc::alias(QLatin1String("threadsafe"))
#define COMMAND_TITLE Doc::alias(QLatin1String("title"))
#define COMMAND_WRAPPER Doc::alias(QLatin1String("wrapper"))
QString CodeParser::currentSubDir_;
QList<CodeParser *> CodeParser::parsers;
@ -219,7 +220,8 @@ QSet<QString> CodeParser::commonMetaCommands()
<< COMMAND_SINCE
<< COMMAND_SUBTITLE
<< COMMAND_THREADSAFE
<< COMMAND_TITLE;
<< COMMAND_TITLE
<< COMMAND_WRAPPER;
}
/*!
@ -286,6 +288,9 @@ void CodeParser::processCommonMetaCommand(const Location& location,
else if (command == COMMAND_SINCE) {
node->setSince(arg.first);
}
else if (command == COMMAND_WRAPPER) {
node->setWrapper();
}
else if (command == COMMAND_PAGEKEYWORDS) {
node->addPageKeywords(arg.first);
}

2
src/tools/qdoc/generator.cpp
View File

@ -654,7 +654,7 @@ void Generator::generateBody(const Node *node, CodeMarker *marker)
}
}
if (node->doc().isEmpty()) {
if (!quiet && !node->isReimp()) { // ### might be unnecessary
if (!node->isWrapper() && !quiet && !node->isReimp()) { // ### might be unnecessary
node->location().warning(tr("No documentation for '%1'").arg(node->plainFullName()));
}
}

12
src/tools/qdoc/node.cpp
View File

@ -1078,6 +1078,16 @@ void InnerNode::deleteChildren()
Returns true because this is an inner node.
*/
/*!
Returns true if the node is a class node or a QML type node
that is marked as being a wrapper class or QML type, or if
it is a member of a wrapper class or type.
*/
bool Node::isWrapper() const
{
return (parent_ ? parent_->isWrapper() : false);
}
/*!
*/
const Node *InnerNode::findChildNodeByName(const QString& name) const
@ -1441,6 +1451,7 @@ ClassNode::ClassNode(InnerNode *parent, const QString& name)
: InnerNode(Class, parent, name)
{
abstract_ = false;
wrapper_ = false;
qmlelement = 0;
setPageType(ApiPage);
}
@ -2105,6 +2116,7 @@ QmlClassNode::QmlClassNode(InnerNode *parent, const QString& name)
: DocNode(parent, name, QmlClass, Node::ApiPage),
abstract_(false),
cnodeRequired_(false),
wrapper_(false),
cnode_(0),
baseNode_(0)
{

8
src/tools/qdoc/node.h
View File

@ -200,11 +200,13 @@ public:
virtual bool isCollisionNode() const { return false; }
virtual bool isAttached() const { return false; }
virtual bool isGroup() const { return false; }
virtual bool isWrapper() const;
virtual void addMember(Node* ) { }
virtual bool hasMembers() const { return false; }
virtual bool hasNamespaces() const { return false; }
virtual bool hasClasses() const { return false; }
virtual void setAbstract(bool ) { }
virtual void setWrapper() { }
virtual QString title() const { return QString(); }
virtual bool hasProperty(const QString& ) const { return false; }
virtual void getMemberNamespaces(NodeMap& ) { }
@ -437,8 +439,10 @@ public:
ClassNode(InnerNode* parent, const QString& name);
virtual ~ClassNode() { }
virtual bool isClass() const { return true; }
virtual bool isWrapper() const { return wrapper_; }
virtual QString obsoleteLink() const { return obsoleteLink_; }
virtual void setObsoleteLink(const QString& t) { obsoleteLink_ = t; };
virtual void setWrapper() { wrapper_ = true; }
void addBaseClass(Access access,
ClassNode* node,
@ -463,6 +467,7 @@ private:
QList<RelatedClass> derived;
QList<RelatedClass> ignoredBases;
bool abstract_;
bool wrapper_;
QString sname;
QString obsoleteLink_;
QmlClassNode* qmlelement;
@ -568,7 +573,9 @@ public:
virtual void setCurrentChild();
virtual void clearCurrentChild();
virtual bool isAbstract() const { return abstract_; }
virtual bool isWrapper() const { return wrapper_; }
virtual void setAbstract(bool b) { abstract_ = b; }
virtual void setWrapper() { wrapper_ = true; }
virtual bool isInternal() const { return (status() == Internal); }
virtual QString qmlFullBaseName() const;
virtual QString obsoleteLink() const { return obsoleteLink_; }
@ -592,6 +599,7 @@ public:
private:
bool abstract_;
bool cnodeRequired_;
bool wrapper_;
ClassNode* cnode_;
QString baseName_;
QString obsoleteLink_;

5
src/tools/qdoc/qmlcodeparser.cpp
View File

@ -63,6 +63,7 @@ QT_BEGIN_NAMESPACE
#define COMMAND_PAGEKEYWORDS Doc::alias("pagekeywords")
#define COMMAND_PRELIMINARY Doc::alias("preliminary")
#define COMMAND_SINCE Doc::alias("since")
#define COMMAND_WRAPPER Doc::alias("wrapper")
#define COMMAND_QMLABSTRACT Doc::alias("qmlabstract")
#define COMMAND_QMLCLASS Doc::alias("qmlclass")
@ -228,8 +229,8 @@ QSet<QString> QmlCodeParser::otherMetaCommands()
<< COMMAND_PRELIMINARY
<< COMMAND_SINCE
<< COMMAND_QMLABSTRACT
<< COMMAND_INQMLMODULE;
<< COMMAND_INQMLMODULE
<< COMMAND_WRAPPER;
}
/*!

4
src/tools/qdoc/qmlvisitor.cpp
View File

@ -60,6 +60,7 @@ QT_BEGIN_NAMESPACE
#define COMMAND_PAGEKEYWORDS Doc::alias(QLatin1String("pagekeywords"))
#define COMMAND_PRELIMINARY Doc::alias(QLatin1String("preliminary"))
#define COMMAND_SINCE Doc::alias(QLatin1String("since"))
#define COMMAND_WRAPPER Doc::alias(QLatin1String("wrapper"))
#define COMMAND_QMLABSTRACT Doc::alias(QLatin1String("qmlabstract"))
#define COMMAND_QMLCLASS Doc::alias(QLatin1String("qmlclass"))
@ -367,6 +368,9 @@ void QmlDocVisitor::applyMetacommands(QQmlJS::AST::SourceLocation,
QString arg = args[0].first; //.join(' ');
node->setSince(arg);
}
else if (command == COMMAND_WRAPPER) {
node->setWrapper();
}
else {
doc.location().warning(tr("The \\%1 command is ignored in QML files").arg(command));
}