summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/qmlinfo.cpp
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-04-29 13:33:26 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-04-29 13:33:26 (GMT)
commit33f770b892b2bf46d59c4841e252c85b09b9c4bf (patch)
tree121d233b9bb5483d062bdf3f53765a4c7323e07f /src/declarative/qml/qmlinfo.cpp
parent9bcade632b72da7384d0b006c8d9db26d2f4baa1 (diff)
downloadQt-33f770b892b2bf46d59c4841e252c85b09b9c4bf.zip
Qt-33f770b892b2bf46d59c4841e252c85b09b9c4bf.tar.gz
Qt-33f770b892b2bf46d59c4841e252c85b09b9c4bf.tar.bz2
qdoc: Corrected some qdoc warnings.
Diffstat (limited to 'src/declarative/qml/qmlinfo.cpp')
-rw-r--r--src/declarative/qml/qmlinfo.cpp24
1 files changed, 13 insertions, 11 deletions
diff --git a/src/declarative/qml/qmlinfo.cpp b/src/declarative/qml/qmlinfo.cpp
index a2b304f..65a4298 100644
--- a/src/declarative/qml/qmlinfo.cpp
+++ b/src/declarative/qml/qmlinfo.cpp
@@ -47,12 +47,14 @@ QT_BEGIN_NAMESPACE
\class QmlInfo
\brief The QmlInfo class prints warnings messages that include the file and line number for QML types.
- When QML types display warning messages, it improves tracibility if they include the
- QML file and line number on which the particular instance was instantiated.
+ When QML types display warning messages, it improves tracibility
+ if they include the QML file and line number on which the
+ particular instance was instantiated.
- QmlInfo statements work just like regular Qt qDebug() statements. To include the file
- and line number, an object must be passed. If the file and line number is not available
- for that instance (either it was not instantiated by the QML engine or location
+ QmlInfo statements work just like regular Qt qDebug() statements.
+ To include the file and line number, an object must be passed. If
+ the file and line number is not available for that instance
+ (either it was not instantiated by the QML engine or location
information is disabled), "unknown location" will be used instead.
For example,
@@ -69,7 +71,8 @@ QT_BEGIN_NAMESPACE
*/
/*!
- Construct a QmlInfo, using \a object for file and line number information.
+ Construct a QmlInfo, using \a object for file and line number
+ information.
*/
QmlInfo::QmlInfo(QObject *object)
: QDebug(QtWarningMsg)
@@ -81,17 +84,16 @@ QmlInfo::QmlInfo(QObject *object)
}
/*!
- \internal
+ The destructor does nothing special.
*/
QmlInfo::~QmlInfo()
{
}
/*!
- \fn QmlInfo qmlInfo(QObject *me)
- \internal
-
- XXX - how do we document these?
+ \relates QmlInfo
+ \fn QmlInfo qmlInfo(QObject *me)
+ Constructs an instance of QmlInfo from \a me and returns it.
*/
QT_END_NAMESPACE