Documentation fixes.

Reduce the number of warnings from qdoc. \todo's have been made into
tasks instead.

14 files changed, 23 insertions, 61 deletions

diff --git a/src/declarative/extra/qmlnumberformatter.cpp b/src/declarative/extra/qmlnumberformatter.cpp
index 60b154d..8772305 100644
--- a/src/declarative/extra/qmlnumberformatter.cpp
+++ b/src/declarative/extra/qmlnumberformatter.cpp
@@ -78,6 +78,7 @@ public:
 
     */
 /*!
+    \internal
     \class QmlNumberFormatter
     \ingroup group_utility
     \brief The QmlNumberFormatter class allows you to format a number to a particular string format/locale specific number format.
diff --git a/src/declarative/fx/qfxitem.cpp b/src/declarative/fx/qfxitem.cpp
index ed65b84..9131256 100644
--- a/src/declarative/fx/qfxitem.cpp
+++ b/src/declarative/fx/qfxitem.cpp
@@ -838,23 +838,6 @@ void QFxItem::qmlLoaded()
 }
 
 /*!
-  \qmlproperty Item Item::clipToItem
-
-  Experimental clip to item support.  Do not use.
-
-  \todo complete clip to item support.
- */
-QFxItem *QFxItem::clipToItem() const
-{
-    return 0;
-}
-
-void QFxItem::setClipToItem(QFxItem *)
-{
-    qWarning() << "QFxItem: clipToItem not implemented";
-}
-
-/*!
   \qmlproperty real Item::x
   \qmlproperty real Item::y
   \qmlproperty int Item::width
@@ -1361,7 +1344,7 @@ void QFxItem::setScale(qreal s)
   Opacity is an \e inherited attribute.  That is, the opacity is
   also applied individually to child items.  In almost all cases this
   is what you want.  If you can spot the issue in the following
-  example, you might need to use an opacity filter instead.
+  example, you might need to use an opacity filter (not yet available) instead.
 
   \table
   \row
@@ -1385,8 +1368,6 @@ void QFxItem::setScale(qreal s)
   </Item>
   \endqml
   \endtable
-
-  \todo There is no such thing as an opacity filter
 */
 
 qreal QFxItem::opacity() const
@@ -1488,8 +1469,8 @@ QmlList<QmlTransition *>* QFxItem::transitions()
   \qmlproperty list<Filter> Item::filter
   This property holds a list of graphical filters to be applied to the item.
 
-  \l {qmlfilter}{Filters} include things like \l {qmlblur}{blurring}
-  the item, or giving it a Reflection.  Some
+  \l {Filter}{Filters} include things like \l {Blur}{blurring}
+  the item, or giving it a \l Reflection.  Some
   filters may not be available on all canvases; if a filter is not
   available on a certain canvas, it will simply not be applied for
   that canvas (but the XML will still be considered valid).
diff --git a/src/declarative/fx/qfxitem.h b/src/declarative/fx/qfxitem.h
index d3b9899..c47a1e1 100644
--- a/src/declarative/fx/qfxitem.h
+++ b/src/declarative/fx/qfxitem.h
@@ -113,7 +113,6 @@ class Q_DECLARATIVE_EXPORT QFxItem : public QSimpleCanvasItem, public QmlParserS
     Q_PROPERTY(QString state READ state WRITE setState NOTIFY stateChanged)
     Q_PROPERTY(QString qml READ qml WRITE setQml NOTIFY qmlChanged)
     Q_PROPERTY(QFxItem *qmlItem READ qmlItem NOTIFY qmlChanged)
-    Q_PROPERTY(QFxItem *clipToItem READ clipToItem WRITE setClipToItem)
     Q_PROPERTY(qreal x READ x WRITE setX NOTIFY leftChanged)
     Q_PROPERTY(qreal y READ y WRITE setY NOTIFY topChanged)
     Q_PROPERTY(qreal z READ z WRITE setZ)
@@ -174,9 +173,6 @@ public:
     QString qml() const;
     void setQml(const QString &);
 
-    QFxItem *clipToItem() const;
-    void setClipToItem(QFxItem *i);
-
     bool flipVertically() const;
     void setFlipVertically(bool);
     bool flipHorizontally() const;
diff --git a/src/declarative/fx/qfxpainted.cpp b/src/declarative/fx/qfxpainted.cpp
index 8109efa..ad1b3ad 100644
--- a/src/declarative/fx/qfxpainted.cpp
+++ b/src/declarative/fx/qfxpainted.cpp
@@ -77,13 +77,12 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    Constructs the painted item.
+    Constructs a painted item with parent object \a parent.
 */
-
-//### what options do we need to set?
 QFxPainted::QFxPainted(QFxItem *parent)
   : QFxItem(*(new QFxPaintedPrivate), parent)
 {
+    //### what options do we need to set?
     setOptions(HasContents, true);
 }
 
@@ -105,8 +104,9 @@ QFxPainted::QFxPainted(QFxPaintedPrivate &dd, QFxItem *parent)
 /*!
     \fn QFxPainted::paint(QPainter *painter)
 
-    Implement this method to paint the item.  The painting will be cached and
-    paint() will only be called again if \l markDirty() has been called.
+    Implement this method to paint the item using \a painter.
+    The painting will be cached and paint() will only be called again
+    if \l markDirty() has been called.
 
     \sa markDirty()
 */
diff --git a/src/declarative/fx/qfxparticles.cpp b/src/declarative/fx/qfxparticles.cpp
index 939afba..9319c46 100644
--- a/src/declarative/fx/qfxparticles.cpp
+++ b/src/declarative/fx/qfxparticles.cpp
@@ -917,7 +917,7 @@ void QFxParticles::setStreamIn(bool b)
   will be produced until it is set to true.
 */
 /*!
-  \property bool Particles::emitting
+  \property QFxParticles::emitting
   If emitting is set to false no new particles will be created. This means that
   when a particle reaches the end of its lifespan it is not replaced. This
   property can be used to turn particles on and off with a more natural look.
diff --git a/src/declarative/fx/qfxrect.cpp b/src/declarative/fx/qfxrect.cpp
index 2e84c74..a761ec5 100644
--- a/src/declarative/fx/qfxrect.cpp
+++ b/src/declarative/fx/qfxrect.cpp
@@ -70,10 +70,7 @@ QML_DEFINE_TYPE(QFxPen,Pen);
     \brief the color of the pen.
 
     color is most commonly specified in hexidecimal notation (#RRGGBB)
-    or as an
-    \htmlonly
-    <a href="http://www.w3.org/TR/SVG/types.html#ColorKeywords"> SVG color keyword name</a>
-    \endhtmlonly
+    or as an \l {http://www.w3.org/TR/SVG/types.html#ColorKeywords}{SVG color keyword name}
      (as defined by the World Wide Web Consortium). For example:
     \code
     <!-- rect with green border using hexidecimal notation -->
diff --git a/src/declarative/fx/qfxreflectionfilter.cpp b/src/declarative/fx/qfxreflectionfilter.cpp
index d67095b..39342d7 100644
--- a/src/declarative/fx/qfxreflectionfilter.cpp
+++ b/src/declarative/fx/qfxreflectionfilter.cpp
@@ -103,9 +103,6 @@ public:
 
     Reflection is only supported when Qt Declarative is compiled for OpenGL ES 2.0.
     Otherwise the Reflection filter has no effect.
-    
-    \todo describe (and fix) reflection and bounding box interaction
-
 */
 
 /*!
diff --git a/src/declarative/fx/qfxrepeater.cpp b/src/declarative/fx/qfxrepeater.cpp
index ec1d88c..570d54d 100644
--- a/src/declarative/fx/qfxrepeater.cpp
+++ b/src/declarative/fx/qfxrepeater.cpp
@@ -110,13 +110,7 @@ QML_DEFINE_TYPE(QFxRepeater,Repeater);
 
     The repeater instance continues to own all items it instantiates, even
     if they are otherwise manipulated.  It is illegal to manually remove an item
-    created by the Repeater.  
-
-    \todo Repeater is very conservative in how it instatiates/deletes items.  
-    Also new model entries will not be created and old ones will not be removed.
-
-    \todo Need an example
-
+    created by the Repeater.
  */
 
 /*!
diff --git a/src/declarative/fx/qfxtext.cpp b/src/declarative/fx/qfxtext.cpp
index bc03d7c..e7085d8 100644
--- a/src/declarative/fx/qfxtext.cpp
+++ b/src/declarative/fx/qfxtext.cpp
@@ -85,8 +85,6 @@ QML_DEFINE_TYPE(QFxText,Text);
     plain text to a set width.
 
     Text provides read-only text. For editable text, see \l TextEdit.
-
-    \todo explain details of auto-sizing
 */
 
 /*!
diff --git a/src/declarative/fx/qfxtextedit.cpp b/src/declarative/fx/qfxtextedit.cpp
index 96ebe0d..7efb826 100644
--- a/src/declarative/fx/qfxtextedit.cpp
+++ b/src/declarative/fx/qfxtextedit.cpp
@@ -294,7 +294,7 @@ void QFxTextEdit::setColor(const QColor &color)
 */
 
 /*!
-    \property QFxText::hAlign
+    \property QFxTextEdit::hAlign
     \brief the horizontal alignment of the text.
 
     Valid values are \c AlignLeft, \c AlignRight, and \c AlignHCenter. The default value is \c AlignLeft.
@@ -316,7 +316,7 @@ void QFxTextEdit::setHAlign(QFxTextEdit::HAlignment alignment)
 }
 
 /*!
-    \property QFxText::vAlign
+    \property QFxTextEdit::vAlign
     \brief the vertical alignment of the text.
 
     Valid values are \c AlignTop, \c AlignBottom, and \c AlignVCenter. The default value is \c AlignTop.
diff --git a/src/declarative/fx/qfxtransform.cpp b/src/declarative/fx/qfxtransform.cpp
index 90875a6..a001214 100644
--- a/src/declarative/fx/qfxtransform.cpp
+++ b/src/declarative/fx/qfxtransform.cpp
@@ -56,8 +56,6 @@ QML_DEFINE_TYPE(QFxTransform,Transform);
 /*!
     \qmlclass Transform
     \brief A transformation.
-
-    \todo Document Transform.
 */
 QFxTransform::QFxTransform(QObject *parent) :
     QObject(parent)
@@ -334,9 +332,6 @@ public:
     \endcode
 
     \image flipable.gif
-
-    \todo A lot needs to be done to get a fully-functioning Flipable. Should we simplify?
-
 */
 
 /*!
diff --git a/src/declarative/fx/qfxwidgetcontainer.cpp b/src/declarative/fx/qfxwidgetcontainer.cpp
index 44ccf0f..f86c8dc 100644
--- a/src/declarative/fx/qfxwidgetcontainer.cpp
+++ b/src/declarative/fx/qfxwidgetcontainer.cpp
@@ -73,7 +73,7 @@ QGraphicsWidget *QFxWidgetContainer::graphicsWidget() const
 }
 
 /*!
-    \property QGraphicsWidget QFxWidgetContainer::graphicsWidget
+    \qmlproperty QGraphicsWidget QFxWidgetContainer::graphicsWidget
     The QGraphicsWidget associated with this element.
 */
 void QFxWidgetContainer::setGraphicsWidget(QGraphicsWidget *widget)
diff --git a/src/declarative/qml/qmlengine.cpp b/src/declarative/qml/qmlengine.cpp
index 63f45b4..24570d5 100644
--- a/src/declarative/qml/qmlengine.cpp
+++ b/src/declarative/qml/qmlengine.cpp
@@ -465,7 +465,7 @@ QmlContext *QmlEngine::activeContext()
 /*!
     Sets the mappings from namespace URIs to URL to \a map.
 
-    \sa nameSpacePaths
+    \sa nameSpacePaths()
 */
 void QmlEngine::setNameSpacePaths(const QMap<QString,QString>& map)
 {
@@ -476,7 +476,7 @@ void QmlEngine::setNameSpacePaths(const QMap<QString,QString>& map)
 /*!
     Adds mappings (given by \a map) from namespace URIs to URL.
 
-    \sa nameSpacePaths
+    \sa nameSpacePaths()
 */
 void QmlEngine::addNameSpacePaths(const QMap<QString,QString>& map)
 {
@@ -487,7 +487,7 @@ void QmlEngine::addNameSpacePaths(const QMap<QString,QString>& map)
 /*!
     Adds a mapping from namespace URI \a ns to URL \a path.
 
-    \sa nameSpacePaths
+    \sa nameSpacePaths()
 */
 void QmlEngine::addNameSpacePath(const QString& ns, const QString& path)
 {
@@ -525,7 +525,7 @@ void QmlEngine::addNameSpacePath(const QString& ns, const QString& path)
     In the above case, "xyz://abc/def/Bar.qml" would then map to
     "file:///opt/jkl/def/Bar.qml".
 
-    \sa componentUrl
+    \sa componentUrl()
 */
 QMap<QString,QString> QmlEngine::nameSpacePaths() const
 {
@@ -537,7 +537,7 @@ QMap<QString,QString> QmlEngine::nameSpacePaths() const
     Returns the URL for the component source \a src, as mapped
     by the nameSpacePaths(), resolved relative to \a baseUrl.
 
-    \sa nameSpacePaths
+    \sa nameSpacePaths()
 */
 QUrl QmlEngine::componentUrl(const QUrl& src, const QUrl& baseUrl) const
 {
diff --git a/src/declarative/util/qbindablemap.cpp b/src/declarative/util/qbindablemap.cpp
index aea2a2c..341dd31 100644
--- a/src/declarative/util/qbindablemap.cpp
+++ b/src/declarative/util/qbindablemap.cpp
@@ -117,6 +117,9 @@ QBindableMap::QBindableMap(QObject *parent)
     m_mo = new QBindableMapMetaObject(this);
 }
 
+/*!
+    Destroys the bindable map.
+*/
 QBindableMap::~QBindableMap()
 {
 }