diff options
author | Martin Smith <martin.smith@nokia.com> | 2012-07-26 10:48:42 +0200 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-07-26 14:24:40 +0200 |
commit | 3658eedc971a62a5ea8b202e0dd9f89abacdb61e (patch) | |
tree | 8b4fd5a0d7e7cc6cd07733ddb7d68060177951a5 /src/tools/qdoc/node.h | |
parent | 353069f974c62ef758b1496881a03fcb6ca51476 (diff) |
qdoc: Changed \qmlclass to \qmltype, added \instantiates
The \qmlclass qdoc command is now deprecated. Use \qmltype instead.
\qmlclass had two arguments, the QML type name and, if the QML type
was elemental, the name of the C++ class that the QML element
instantiates. The \qmltype command has only one argument, the QML type
name.
If the QML type is elemental, then the \qmltype command should be
followed by a \instantiates context command in the same qdoc
comment. e.g.:
\qmltype Item
\instantiates QDeclarativeItem
When the developer does not include the \instantiates command for an
elemental QML type, qdoc will no longer be able to detect that the C++
class name is missing, and qdoc will no longer be able to detect when
the name specified for a \qmlproperty of the elemental QML type has
the wrong name.
Task nr: QTBUG-26648
Change-Id: Ia60872a35113a6f615bfc751ce1e9db6279dfb8e
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
Diffstat (limited to 'src/tools/qdoc/node.h')
-rw-r--r-- | src/tools/qdoc/node.h | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/src/tools/qdoc/node.h b/src/tools/qdoc/node.h index b89eeb89e1..fbb6c6f7c4 100644 --- a/src/tools/qdoc/node.h +++ b/src/tools/qdoc/node.h @@ -227,7 +227,6 @@ public: void clearRelated() { relatesTo_ = 0; } - //virtual QString fileBase() const; QString guid() const; QString extractClassName(const QString &string) const; virtual QString qmlTypeName() const { return name_; } @@ -236,6 +235,7 @@ public: virtual QString qmlModuleIdentifier() const { return qmlModuleName_ + qmlModuleVersionMajor_; } virtual bool setQmlModule(const ArgLocPair& ); virtual ClassNode* classNode() { return 0; } + virtual void setClassNode(ClassNode* ) { } virtual void clearCurrentChild() { } virtual const ImportList* importList() const { return 0; } virtual void setImportList(const ImportList& ) { } @@ -521,14 +521,12 @@ private: class QmlClassNode : public FakeNode { public: - QmlClassNode(InnerNode* parent, - const QString& name, - ClassNode* cn); + QmlClassNode(InnerNode* parent, const QString& name); virtual ~QmlClassNode(); virtual bool isQmlNode() const { return true; } virtual bool isQtQuickNode() const { return (qmlModuleName() == QLatin1String("QtQuick")); } virtual ClassNode* classNode() { return cnode_; } - //virtual QString fileBase() const; + virtual void setClassNode(ClassNode* cn) { cnode_ = cn; } virtual void setCurrentChild(); virtual void clearCurrentChild(); virtual const ImportList* importList() const { return &importList_; } |