summaryrefslogtreecommitdiffstats
path: root/src/declarative
diff options
context:
space:
mode:
authorMartin Smith <msmith@trolltech.com>2009-05-05 13:22:30 (GMT)
committerMartin Smith <msmith@trolltech.com>2009-05-05 13:22:30 (GMT)
commit7495bee56210a99b04f6c5497dc4ef8487fe3362 (patch)
tree18237db40e356a4484d836d4ee3943bf58eabf7c /src/declarative
parent98e4bd5b79f0a7ecd1381408ba95a32ae700b43d (diff)
downloadQt-7495bee56210a99b04f6c5497dc4ef8487fe3362.zip
Qt-7495bee56210a99b04f6c5497dc4ef8487fe3362.tar.gz
Qt-7495bee56210a99b04f6c5497dc4ef8487fe3362.tar.bz2
qdoc: Corrected some qdoc warnings.
Diffstat (limited to 'src/declarative')
-rw-r--r--src/declarative/fx/qfxparticles.cpp8
-rw-r--r--src/declarative/qml/qmlcontext.cpp12
-rw-r--r--src/declarative/qml/qmlengine.cpp15
-rw-r--r--src/declarative/qml/qmlpropertyvaluesource.cpp7
-rw-r--r--src/declarative/util/qfxview.cpp8
5 files changed, 30 insertions, 20 deletions
diff --git a/src/declarative/fx/qfxparticles.cpp b/src/declarative/fx/qfxparticles.cpp
index b1f4f56..8535a73 100644
--- a/src/declarative/fx/qfxparticles.cpp
+++ b/src/declarative/fx/qfxparticles.cpp
@@ -113,8 +113,6 @@ QML_DEFINE_TYPE(QFxParticleMotion,ParticleMotion);
\brief The QFxParticleMotion class is the base class for particle motion.
This class causes the particles to remain static.
-
- \sa QFxParticles
*/
/*!
@@ -165,8 +163,6 @@ void QFxParticleMotion::destroy(QFxParticle &particle)
\class QFxParticleMotionLinear
\ingroup group_effects
\brief The QFxParticleMotionLinear class moves the particles linearly.
-
- \sa QFxParticles
*/
QML_DEFINE_TYPE(QFxParticleMotionLinear,ParticleMotionLinear);
@@ -189,8 +185,6 @@ void QFxParticleMotionLinear::advance(QFxParticle &p, int interval)
\class QFxParticleMotionGravity
\ingroup group_effects
\brief The QFxParticleMotionGravity class moves the particles towards a point.
-
- \sa QFxParticles
*/
QML_DEFINE_TYPE(QFxParticleMotionGravity,ParticleMotionGravity);
@@ -281,8 +275,6 @@ Rect {
The particles will continue roughly in the original direction, however will randomly
drift to each side.
-
- \sa QFxParticles
*/
/*!
diff --git a/src/declarative/qml/qmlcontext.cpp b/src/declarative/qml/qmlcontext.cpp
index 6330eda..68453c3 100644
--- a/src/declarative/qml/qmlcontext.cpp
+++ b/src/declarative/qml/qmlcontext.cpp
@@ -341,7 +341,7 @@ QmlContext *QmlContext::activeContext()
simply returned. If there is no containing component,
an empty URL is returned.
- \sa QmlEngine::componentUrl(), setBaseUrl
+ \sa QmlEngine::componentUrl(), setBaseUrl()
*/
QUrl QmlContext::resolvedUrl(const QUrl &src)
{
@@ -370,7 +370,7 @@ QUrl QmlContext::resolvedUrl(const QUrl &src)
\l {QmlEngine::nameSpacePaths()} {namespace paths} of the
context's engine, returning the resolved URL.
- \sa QmlEngine::componentUrl(), setBaseUrl
+ \sa QmlEngine::componentUrl(), setBaseUrl()
*/
QUrl QmlContext::resolvedUri(const QUrl &src)
{
@@ -394,11 +394,13 @@ QUrl QmlContext::resolvedUri(const QUrl &src)
}
/*!
- Explicitly sets the url both resolveUri() and resolveUrl() will use for relative references.
+ Explicitly sets the url both resolveUri() and resolveUrl() will
+ use for relative references to \a baseUrl.
- Calling this function will override the url of the containing component used by default.
+ Calling this function will override the url of the containing
+ component used by default.
- \sa resolvedUrl, resolvedUri
+ \sa resolvedUrl(), resolvedUri()
*/
void QmlContext::setBaseUrl(const QUrl &baseUrl)
{
diff --git a/src/declarative/qml/qmlengine.cpp b/src/declarative/qml/qmlengine.cpp
index f8b7ad6..bcea325 100644
--- a/src/declarative/qml/qmlengine.cpp
+++ b/src/declarative/qml/qmlengine.cpp
@@ -408,6 +408,9 @@ QmlEngine::~QmlEngine()
{
}
+/*!
+ Clears the engine's internal component cache.
+ */
void QmlEngine::clearComponentCache()
{
Q_D(QmlEngine);
@@ -582,8 +585,8 @@ void QmlEngine::setNetworkAccessManager(QNetworkAccessManager *network)
}
/*!
- Returns the common QNetworkAccessManager used by all QML elements instantiated by
- this engine.
+ Returns the common QNetworkAccessManager used by all QML elements
+ instantiated by this engine.
The default implements no caching, cookiejar, etc., just a default
QNetworkAccessManager.
@@ -596,6 +599,9 @@ QNetworkAccessManager *QmlEngine::networkAccessManager() const
return d->networkAccessManager;
}
+/*!
+ Returns the QmlContext for the \a object.
+ */
QmlContext *QmlEngine::contextForObject(const QObject *object)
{
QObjectPrivate *priv = QObjectPrivate::get(const_cast<QObject *>(object));
@@ -606,6 +612,11 @@ QmlContext *QmlEngine::contextForObject(const QObject *object)
return data?data->context:0;
}
+/*!
+ Sets the QmlContext for the \a object to \a context.
+ If the \a object already has a context, a warning is
+ output, but the context is not changed.
+ */
void QmlEngine::setContextForObject(QObject *object, QmlContext *context)
{
QObjectPrivate *priv = QObjectPrivate::get(object);
diff --git a/src/declarative/qml/qmlpropertyvaluesource.cpp b/src/declarative/qml/qmlpropertyvaluesource.cpp
index 44e1952..4770929 100644
--- a/src/declarative/qml/qmlpropertyvaluesource.cpp
+++ b/src/declarative/qml/qmlpropertyvaluesource.cpp
@@ -59,14 +59,17 @@ QmlPropertyValueSource::QmlPropertyValueSource(QObject *parent)
{
}
+/*!
+ \internal
+ */
QmlPropertyValueSource::QmlPropertyValueSource(QObjectPrivate &dd, QObject *parent)
: QObject(dd, parent)
{
}
/*!
- Set the target \a property for the value source. This method will be called
- by the QML engine when assigning a value source.
+ Set the target \a property for the value source. This method will
+ be called by the QML engine when assigning a value source.
The default implementation does nothing.
*/
diff --git a/src/declarative/util/qfxview.cpp b/src/declarative/util/qfxview.cpp
index f71b87e..1315f19 100644
--- a/src/declarative/util/qfxview.cpp
+++ b/src/declarative/util/qfxview.cpp
@@ -348,7 +348,7 @@ void QFxView::continueExecute()
}
/*! \fn void QFxView::sceneResized(QSize size)
- This signal is emitted when the view is resized.
+ This signal is emitted when the view is resized to \a size.
*/
/*!
@@ -458,7 +458,8 @@ void QFxView::resizeEvent(QResizeEvent *e)
}
/*! \fn void QFxView::focusInEvent(QFocusEvent *e)
- This virtual function does nothing in this class.
+ This virtual function does nothing with the event \a e
+ in this class.
*/
void QFxView::focusInEvent(QFocusEvent *)
{
@@ -467,7 +468,8 @@ void QFxView::focusInEvent(QFocusEvent *)
/*! \fn void QFxView::focusOutEvent(QFocusEvent *e)
- This virtual function does nothing in this class.
+ This virtual function does nothing with the event \a e
+ in this class.
*/
void QFxView::focusOutEvent(QFocusEvent *)
{