qdoc: Changed \qmlclass to \qmltype, added \instantiates
authorMartin Smith <martin.smith@nokia.com>
Thu, 26 Jul 2012 08:48:42 +0000 (10:48 +0200)
committerQt by Nokia <qt-info@nokia.com>
Thu, 26 Jul 2012 12:24:40 +0000 (14:24 +0200)
commit3658eedc971a62a5ea8b202e0dd9f89abacdb61e
tree8b4fd5a0d7e7cc6cd07733ddb7d68060177951a5
parent353069f974c62ef758b1496881a03fcb6ca51476
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>
src/tools/qdoc/cppcodeparser.cpp
src/tools/qdoc/cppcodeparser.h
src/tools/qdoc/node.cpp
src/tools/qdoc/node.h
src/tools/qdoc/qmlcodeparser.cpp
src/tools/qdoc/qmlvisitor.cpp
src/tools/qdoc/tree.cpp