qdoc: Corrected some qdoc warnings.

5 files changed, 52 insertions, 19 deletions

diff --git a/src/declarative/fx/qfxcomponentinstance.cpp b/src/declarative/fx/qfxcomponentinstance.cpp
index 951c25d..5343f7d 100644
--- a/src/declarative/fx/qfxcomponentinstance.cpp
+++ b/src/declarative/fx/qfxcomponentinstance.cpp
@@ -51,15 +51,14 @@ QML_DEFINE_TYPE(QFxComponentInstance,ComponentInstance);
 
 /*!
     \internal
-    \class QFxComponentInstance
-    \qmlclass ComponentInstance
+    \class QFxComponentInstance ComponentInstance
 
     \brief The QFxComponentInstance class provides a way to instantiate an item from a component.
  */
 
 /*!
     \qmlclass ComponentInstance QFxComponentInstance
-    \brief The ComponentInstance element allows you to instantiate an arbitrary component.
+    \brief The ComponentInstance element allows you to instantiate a \l{qml-component.html} {Component}.
 
     \code
     <Item>
diff --git a/src/declarative/fx/qfxhighlightfilter.cpp b/src/declarative/fx/qfxhighlightfilter.cpp
index ab0512c..70b50cd 100644
--- a/src/declarative/fx/qfxhighlightfilter.cpp
+++ b/src/declarative/fx/qfxhighlightfilter.cpp
@@ -119,7 +119,7 @@ QFxHighlightFilter::~QFxHighlightFilter()
 */
 
 /*!
-    \property QFxHighlightFilter::src
+    \property QFxHighlightFilter::source
     \brief the URL of the image to be used as the highlight.
 */
 QString QFxHighlightFilter::source() const
diff --git a/src/declarative/fx/qfxparticles.cpp b/src/declarative/fx/qfxparticles.cpp
index b6b4c85..16b3570 100644
--- a/src/declarative/fx/qfxparticles.cpp
+++ b/src/declarative/fx/qfxparticles.cpp
@@ -573,7 +573,7 @@ QFxParticles::~QFxParticles()
 */
 
 /*!
-    \property QFxParticles::src
+    \property QFxParticles::source
     \brief the URL of the particle image.
 */
 QString QFxParticles::source() const
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
diff --git a/src/declarative/util/qfxview.cpp b/src/declarative/util/qfxview.cpp
index 1e9d5a4..e285890 100644
--- a/src/declarative/util/qfxview.cpp
+++ b/src/declarative/util/qfxview.cpp
@@ -107,10 +107,10 @@ public:
     \class QFxView
     \brief The QFxView class provides a widget for displaying a Qt Declarative user interface.
 
-    QFxView currently provides a minimal interface for displaying Qml files, and
-    connecting between QML and C++ Qt objects.
+    QFxView currently provides a minimal interface for displaying QML
+    files, and connecting between QML and C++ Qt objects.
 
-    Typcial usage looks something like this:
+    Typcial usage:
     \code
     ...
     QFxView *view = new QFxView(this);
@@ -129,12 +129,24 @@ public:
     \endcode
 */
 
+/*!
+  \fn QFxView::QFxView(QWidget *parent)
+  
+  Constructs a QFxView with the given \a parent.
+*/
 QFxView::QFxView(QWidget *parent)
 : QSimpleCanvas(parent), d(new QFxViewPrivate(this))
 {
     d->init();
 }
 
+/*!
+  \fn QFxView::QFxView(QSimpleCanvas::CanvasMode mode, QWidget *parent)
+  
+  Constructs a QFxView with the given \a parent. The canvas
+  \a mode can be QSimpleCanvas::GraphicsView or
+  QSimpleCanvas::SimpleCanvas.
+*/
 QFxView::QFxView(QSimpleCanvas::CanvasMode mode, QWidget *parent)
 : QSimpleCanvas(mode, parent), d(new QFxViewPrivate(this))
 {
@@ -157,29 +169,49 @@ void QFxViewPrivate::init()
     QFontDatabase database;
 }
 
+/*!
+  The destructor clears the instance and deletes the internal
+  representation.
+
+  \sa clearItems()
+ */
 QFxView::~QFxView()
 {
     clearItems();
     delete d; d = 0;
 }
 
+/*!
+  Sets the source to the \a url. The XML string is set to
+  empty.
+ */
 void QFxView::setUrl(const QUrl& url)
 {
     d->source = url;
     d->xml = QString();
 }
 
+/*!
+  Sets the source to the URL from the \a filename, and sets
+  the XML string to \a xml.
+ */
 void QFxView::setXml(const QString &xml, const QString &filename)
 {
     d->source = QUrl::fromLocalFile(filename);
     d->xml = xml;
 }
 
+/*!
+  Returns the XML string.
+ */
 QString QFxView::xml() const
 {
     return d->xml;
 }
 
+/*!
+  Returns a pointer to the QmlEngine.
+ */
 QmlEngine* QFxView::engine()
 {
     return &d->engine;