From e5534b9ba700fa2b25fa63e181e2c5f82469875d Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Tue, 16 Feb 2010 11:27:56 +0100 Subject: doc: Fixed some qdoc errors. --- doc/src/declarative/qmlmodels.qdoc | 6 +++++- src/dbus/qdbusmessage.cpp | 7 +++---- src/declarative/qml/qmlcontext.cpp | 6 +++++- src/declarative/qml/qmlengine.cpp | 6 +++++- src/declarative/qml/qmlnetworkaccessmanagerfactory.cpp | 4 ++++ src/opengl/qglframebufferobject.cpp | 2 +- src/opengl/qglshaderprogram.cpp | 11 +++++------ 7 files changed, 28 insertions(+), 14 deletions(-) diff --git a/doc/src/declarative/qmlmodels.qdoc b/doc/src/declarative/qmlmodels.qdoc index 008ea2a..1f933ad 100644 --- a/doc/src/declarative/qmlmodels.qdoc +++ b/doc/src/declarative/qmlmodels.qdoc @@ -198,6 +198,10 @@ QAbstractItemModel provides the roles set via the QAbstractItemModel::setRoleNam QStringList provides the contents of the list via the \e modelData role: \table +\header +\o +\o +\row \o \code // main.cpp @@ -228,7 +232,7 @@ ListView { \endcode \endtable -Note: There is no way for the view to know that the contents of a QStringList +\note There is no way for the view to know that the contents of a QStringList have changed. If the QStringList is changed, it will be necessary to reset the model by calling QmlContext::setContextProperty() again. diff --git a/src/dbus/qdbusmessage.cpp b/src/dbus/qdbusmessage.cpp index 79c7644..30ddc61 100644 --- a/src/dbus/qdbusmessage.cpp +++ b/src/dbus/qdbusmessage.cpp @@ -645,10 +645,9 @@ bool QDBusMessage::isDelayedReply() const } /*! - Sets whether this message will have the auto start flag. - This flag only makes sense for method call messages. For - these messages it tells the D-Bus server to either auto - start the service responsible for the service name, or + Sets the auto start flag to \a enable. This flag only makes sense + for method call messages, where it tells the D-Bus server to + either auto start the service responsible for the service name, or not to auto start it. By default this flag is true, i.e. a service is autostarted. diff --git a/src/declarative/qml/qmlcontext.cpp b/src/declarative/qml/qmlcontext.cpp index d9fc76b..bf8bdad 100644 --- a/src/declarative/qml/qmlcontext.cpp +++ b/src/declarative/qml/qmlcontext.cpp @@ -428,7 +428,7 @@ void QmlContextPrivate::setIdPropertyData(QmlIntegerCache *data) } /*! - Set a the \a value of the \a name property on this context. + Set the \a value of the \a name property on this context. QmlContext does \bold not take ownership of \a value. */ @@ -452,6 +452,10 @@ void QmlContext::setContextProperty(const QString &name, QObject *value) } } +/*! + Returns the value of the \a name property for this context + as a QVariant. + */ QVariant QmlContext::contextProperty(const QString &name) const { Q_D(const QmlContext); diff --git a/src/declarative/qml/qmlengine.cpp b/src/declarative/qml/qmlengine.cpp index cdbe5f3..6a7bd81 100644 --- a/src/declarative/qml/qmlengine.cpp +++ b/src/declarative/qml/qmlengine.cpp @@ -383,6 +383,10 @@ QmlEngine::~QmlEngine() QmlEngineDebugServer::remEngine(this); } +/*! \fn void QmlEngine::quit() + This signal is emitted when the QmlEngine quits. + */ + /*! Clears the engine's internal component cache. @@ -999,7 +1003,7 @@ QScriptValue QmlEnginePrivate::consoleLog(QScriptContext *ctxt, QScriptEngine *e void QmlEnginePrivate::sendQuit () { Q_Q(QmlEngine); - emit q->quit (); + emit q->quit(); } QScriptValue QmlEnginePrivate::quit(QScriptContext * /*ctxt*/, QScriptEngine *e) diff --git a/src/declarative/qml/qmlnetworkaccessmanagerfactory.cpp b/src/declarative/qml/qmlnetworkaccessmanagerfactory.cpp index 76f20d8..1e367d4 100644 --- a/src/declarative/qml/qmlnetworkaccessmanagerfactory.cpp +++ b/src/declarative/qml/qmlnetworkaccessmanagerfactory.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE Note: the create() method may be called by multiple threads, so ensure the implementation of this method is reentrant. */ + +/*! + The destructor is empty. + */ QmlNetworkAccessManagerFactory::~QmlNetworkAccessManagerFactory() { } diff --git a/src/opengl/qglframebufferobject.cpp b/src/opengl/qglframebufferobject.cpp index f1d2325..7bebd46 100644 --- a/src/opengl/qglframebufferobject.cpp +++ b/src/opengl/qglframebufferobject.cpp @@ -128,7 +128,7 @@ void QGLFramebufferObjectFormat::detach() attachments, texture target \c GL_TEXTURE_2D, and internal format \c GL_RGBA8. On OpenGL/ES systems, the default internal format is \c GL_RGBA. - \sa samples(), attachment(), target(), internalTextureFormat() + \sa samples(), attachment(), internalTextureFormat() */ QGLFramebufferObjectFormat::QGLFramebufferObjectFormat() diff --git a/src/opengl/qglshaderprogram.cpp b/src/opengl/qglshaderprogram.cpp index c18129d..739983e 100644 --- a/src/opengl/qglshaderprogram.cpp +++ b/src/opengl/qglshaderprogram.cpp @@ -3082,7 +3082,7 @@ void QGLShaderProgram::setUniformValueArray(const char *name, const QMatrix4x4 * \since 4.7 - \sa setGeometryShaderOutputVertexCount + \sa setGeometryOutputVertexCount() */ int QGLShaderProgram::maxGeometryOutputVertices() const { @@ -3091,11 +3091,9 @@ int QGLShaderProgram::maxGeometryOutputVertices() const return n; } - - /*! Sets the maximum number of vertices the current geometry shader - program will produce, if active. + program will produce, if active, to \a count. \since 4.7 @@ -3129,7 +3127,7 @@ int QGLShaderProgram::geometryOutputVertexCount() const /*! - Sets the output type from the geometry shader, if active. + Sets the input type from \a inputType. This parameter takes effect the next time the program is linked. */ @@ -3154,7 +3152,8 @@ GLenum QGLShaderProgram::geometryInputType() const /*! - Sets the output type from the geometry shader, if active. + Sets the output type from the geometry shader, if active, to + \a outputType. This parameter takes effect the next time the program is linked. -- cgit v0.12