summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml
diff options
context:
space:
mode:
authorCasper van Donderen <casper.vandonderen@nokia.com>2012-03-01 19:02:20 +0100
committerQt by Nokia <qt-info@nokia.com>2012-03-13 15:27:31 +0100
commitc051ea15c75851132d08f22825d84d4ea3f49241 (patch)
treeea3aa28296355f313d204f6e190f74cfd87dee0a /src/declarative/qml
parentdc5c8d1099ac851b51accf5f87c5be4fc1610c1a (diff)
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold and list items. This change applies that change in QDoc to the actual documentation. Task-number: QTBUG-24578 Change-Id: Iae34eb8f2233dd9dbec79e7ab3c324f3f505b4cc Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/declarative/qml')
-rw-r--r--src/declarative/qml/qdeclarativecomponent.cpp14
-rw-r--r--src/declarative/qml/qdeclarativecontext.cpp2
-rw-r--r--src/declarative/qml/qdeclarativeengine.cpp116
-rw-r--r--src/declarative/qml/qdeclarativeextensionplugin.cpp6
-rw-r--r--src/declarative/qml/qdeclarativeimageprovider.cpp6
-rw-r--r--src/declarative/qml/qdeclarativeimport.cpp20
-rw-r--r--src/declarative/qml/qdeclarativenetworkaccessmanagerfactory.cpp4
-rw-r--r--src/declarative/qml/qdeclarativetypeloader.cpp22
-rw-r--r--src/declarative/qml/qdeclarativeworkerscript.cpp6
9 files changed, 98 insertions, 98 deletions
diff --git a/src/declarative/qml/qdeclarativecomponent.cpp b/src/declarative/qml/qdeclarativecomponent.cpp
index ffd5dfb8..3a219be2 100644
--- a/src/declarative/qml/qdeclarativecomponent.cpp
+++ b/src/declarative/qml/qdeclarativecomponent.cpp
@@ -320,10 +320,10 @@ QDeclarativeComponent::~QDeclarativeComponent()
\qmlproperty enumeration Component::status
This property holds the status of component loading. It can be one of:
\list
- \o Component.Null - no data is available for the component
- \o Component.Ready - the component has been loaded, and can be used to create instances.
- \o Component.Loading - the component is currently being loaded
- \o Component.Error - an error occurred while loading the component.
+ \li Component.Null - no data is available for the component
+ \li Component.Ready - the component has been loaded, and can be used to create instances.
+ \li Component.Loading - the component is currently being loaded
+ \li Component.Error - an error occurred while loading the component.
Calling errorString() will provide a human-readable description of any errors.
\endlist
*/
@@ -780,9 +780,9 @@ QObject *QDeclarativeComponent::create(QDeclarativeContext *context)
When QDeclarativeComponent constructs an instance, it occurs in three steps:
\list 1
- \i The object hierarchy is created, and constant values are assigned.
- \i Property bindings are evaluated for the the first time.
- \i If applicable, QDeclarativeParserStatus::componentComplete() is called on objects.
+ \li The object hierarchy is created, and constant values are assigned.
+ \li Property bindings are evaluated for the the first time.
+ \li If applicable, QDeclarativeParserStatus::componentComplete() is called on objects.
\endlist
QDeclarativeComponent::beginCreate() differs from QDeclarativeComponent::create() in that it
only performs step 1. QDeclarativeComponent::completeCreate() must be called to
diff --git a/src/declarative/qml/qdeclarativecontext.cpp b/src/declarative/qml/qdeclarativecontext.cpp
index 1dee77ae..7729e513 100644
--- a/src/declarative/qml/qdeclarativecontext.cpp
+++ b/src/declarative/qml/qdeclarativecontext.cpp
@@ -330,7 +330,7 @@ void QDeclarativeContext::setContextProperty(const QString &name, const QVariant
/*!
Set the \a value of the \a name property on this context.
- QDeclarativeContext does \bold not take ownership of \a value.
+ QDeclarativeContext does \b not take ownership of \a value.
*/
void QDeclarativeContext::setContextProperty(const QString &name, QObject *value)
{
diff --git a/src/declarative/qml/qdeclarativeengine.cpp b/src/declarative/qml/qdeclarativeengine.cpp
index bee27817..3b77c18b 100644
--- a/src/declarative/qml/qdeclarativeengine.cpp
+++ b/src/declarative/qml/qdeclarativeengine.cpp
@@ -231,11 +231,11 @@ data types. This is primarily useful when setting the properties of an item
when the property has one of the following types:
\list
-\o \c color - use \l{QML:Qt::rgba()}{Qt.rgba()}, \l{QML:Qt::hsla()}{Qt.hsla()}, \l{QML:Qt::darker()}{Qt.darker()}, \l{QML:Qt::lighter()}{Qt.lighter()} or \l{QML:Qt::tint()}{Qt.tint()}
-\o \c rect - use \l{QML:Qt::rect()}{Qt.rect()}
-\o \c point - use \l{QML:Qt::point()}{Qt.point()}
-\o \c size - use \l{QML:Qt::size()}{Qt.size()}
-\o \c vector3d - use \l{QML:Qt::vector3d()}{Qt.vector3d()}
+\li \c color - use \l{QML:Qt::rgba()}{Qt.rgba()}, \l{QML:Qt::hsla()}{Qt.hsla()}, \l{QML:Qt::darker()}{Qt.darker()}, \l{QML:Qt::lighter()}{Qt.lighter()} or \l{QML:Qt::tint()}{Qt.tint()}
+\li \c rect - use \l{QML:Qt::rect()}{Qt.rect()}
+\li \c point - use \l{QML:Qt::point()}{Qt.point()}
+\li \c size - use \l{QML:Qt::size()}{Qt.size()}
+\li \c vector3d - use \l{QML:Qt::vector3d()}{Qt.vector3d()}
\endlist
There are also string based constructors for these types. See \l{qdeclarativebasictypes.html}{QML Basic Types} for more information.
@@ -245,9 +245,9 @@ There are also string based constructors for these types. See \l{qdeclarativebas
The Qt object contains several functions for formatting QDateTime, QDate and QTime values.
\list
- \o \l{QML:Qt::formatDateTime}{string Qt.formatDateTime(datetime date, variant format)}
- \o \l{QML:Qt::formatDate}{string Qt.formatDate(datetime date, variant format)}
- \o \l{QML:Qt::formatTime}{string Qt.formatTime(datetime date, variant format)}
+ \li \l{QML:Qt::formatDateTime}{string Qt.formatDateTime(datetime date, variant format)}
+ \li \l{QML:Qt::formatDate}{string Qt.formatDate(datetime date, variant format)}
+ \li \l{QML:Qt::formatTime}{string Qt.formatTime(datetime date, variant format)}
\endlist
The format specification is described at \l{QML:Qt::formatDateTime}{Qt.formatDateTime}.
@@ -259,8 +259,8 @@ items from files or strings. See \l{Dynamic Object Management in QML} for an ove
of their use.
\list
- \o \l{QML:Qt::createComponent()}{object Qt.createComponent(url)}
- \o \l{QML:Qt::createQmlObject()}{object Qt.createQmlObject(string qml, object parent, string filepath)}
+ \li \l{QML:Qt::createComponent()}{object Qt.createComponent(url)}
+ \li \l{QML:Qt::createQmlObject()}{object Qt.createQmlObject(string qml, object parent, string filepath)}
\endlist
*/
@@ -276,8 +276,8 @@ of their use.
\table
\row
- \o \c application.active
- \o
+ \li \c application.active
+ \li
This read-only property indicates whether the application is the top-most and focused
application, and the user is able to interact with the application. The property
is false when the application is in the background, the device keylock or screen
@@ -288,8 +288,8 @@ of their use.
active.
\row
- \o \c application.layoutDirection
- \o
+ \li \c application.layoutDirection
+ \li
This read-only property can be used to query the default layout direction of the
application. On system start-up, the default layout direction depends on the
application's language. The property has a value of \c Qt.RightToLeft in locales
@@ -300,9 +300,9 @@ of their use.
Possible values are:
\list
- \o Qt.LeftToRight - Text and graphics elements should be positioned
+ \li Qt.LeftToRight - Text and graphics elements should be positioned
from left to right.
- \o Qt.RightToLeft - Text and graphics elements should be positioned
+ \li Qt.RightToLeft - Text and graphics elements should be positioned
from right to left.
\endlist
\endtable
@@ -327,11 +327,11 @@ Qt.include() returns an object that describes the status of the operation. The
a single property, \c {status}, that is set to one of the following values:
\table
-\header \o Symbol \o Value \o Description
-\row \o result.OK \o 0 \o The include completed successfully.
-\row \o result.LOADING \o 1 \o Data is being loaded from the network.
-\row \o result.NETWORK_ERROR \o 2 \o A network error occurred while fetching the url.
-\row \o result.EXCEPTION \o 3 \o A JavaScript exception occurred while executing the included code.
+\header \li Symbol \li Value \li Description
+\row \li result.OK \li 0 \li The include completed successfully.
+\row \li result.LOADING \li 1 \li Data is being loaded from the network.
+\row \li result.NETWORK_ERROR \li 2 \li A network error occurred while fetching the url.
+\row \li result.EXCEPTION \li 3 \li A JavaScript exception occurred while executing the included code.
An additional \c exception property will be set in this case.
\endtable
@@ -1539,54 +1539,54 @@ If \a format is not provided, \a dateTime is formatted using
\a format should be either.
\list
-\o One of the Qt::DateFormat enumeration values, such as
+\li One of the Qt::DateFormat enumeration values, such as
\c Qt.DefaultLocaleShortDate or \c Qt.ISODate
-\o A string that specifies the format of the returned string, as detailed below.
+\li A string that specifies the format of the returned string, as detailed below.
\endlist
If \a format specifies a format string, it should use the following expressions
to specify the date:
\table
- \header \i Expression \i Output
- \row \i d \i the day as number without a leading zero (1 to 31)
- \row \i dd \i the day as number with a leading zero (01 to 31)
- \row \i ddd
- \i the abbreviated localized day name (e.g. 'Mon' to 'Sun').
+ \header \li Expression \li Output
+ \row \li d \li the day as number without a leading zero (1 to 31)
+ \row \li dd \li the day as number with a leading zero (01 to 31)
+ \row \li ddd
+ \li the abbreviated localized day name (e.g. 'Mon' to 'Sun').
Uses QDate::shortDayName().
- \row \i dddd
- \i the long localized day name (e.g. 'Monday' to 'Qt::Sunday').
+ \row \li dddd
+ \li the long localized day name (e.g. 'Monday' to 'Qt::Sunday').
Uses QDate::longDayName().
- \row \i M \i the month as number without a leading zero (1-12)
- \row \i MM \i the month as number with a leading zero (01-12)
- \row \i MMM
- \i the abbreviated localized month name (e.g. 'Jan' to 'Dec').
+ \row \li M \li the month as number without a leading zero (1-12)
+ \row \li MM \li the month as number with a leading zero (01-12)
+ \row \li MMM
+ \li the abbreviated localized month name (e.g. 'Jan' to 'Dec').
Uses QDate::shortMonthName().
- \row \i MMMM
- \i the long localized month name (e.g. 'January' to 'December').
+ \row \li MMMM
+ \li the long localized month name (e.g. 'January' to 'December').
Uses QDate::longMonthName().
- \row \i yy \i the year as two digit number (00-99)
- \row \i yyyy \i the year as four digit number
+ \row \li yy \li the year as two digit number (00-99)
+ \row \li yyyy \li the year as four digit number
\endtable
In addition the following expressions can be used to specify the time:
\table
- \header \i Expression \i Output
- \row \i h
- \i the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)
- \row \i hh
- \i the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)
- \row \i m \i the minute without a leading zero (0 to 59)
- \row \i mm \i the minute with a leading zero (00 to 59)
- \row \i s \i the second without a leading zero (0 to 59)
- \row \i ss \i the second with a leading zero (00 to 59)
- \row \i z \i the milliseconds without leading zeroes (0 to 999)
- \row \i zzz \i the milliseconds with leading zeroes (000 to 999)
- \row \i AP
- \i use AM/PM display. \e AP will be replaced by either "AM" or "PM".
- \row \i ap
- \i use am/pm display. \e ap will be replaced by either "am" or "pm".
+ \header \li Expression \li Output
+ \row \li h
+ \li the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)
+ \row \li hh
+ \li the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)
+ \row \li m \li the minute without a leading zero (0 to 59)
+ \row \li mm \li the minute with a leading zero (00 to 59)
+ \row \li s \li the second without a leading zero (0 to 59)
+ \row \li ss \li the second with a leading zero (00 to 59)
+ \row \li z \li the milliseconds without leading zeroes (0 to 999)
+ \row \li zzz \li the milliseconds with leading zeroes (000 to 999)
+ \row \li AP
+ \li use AM/PM display. \e AP will be replaced by either "AM" or "PM".
+ \row \li ap
+ \li use am/pm display. \e ap will be replaced by either "am" or "pm".
\endtable
All other input characters will be ignored. Any sequence of characters that
@@ -1606,11 +1606,11 @@ This \a dateTime value could be passed to \c Qt.formatDateTime(),
with the \a format values below to produce the following results:
\table
- \header \i Format \i Result
- \row \i "dd.MM.yyyy" \i 21.05.2001
- \row \i "ddd MMMM d yy" \i Tue May 21 01
- \row \i "hh:mm:ss.zzz" \i 14:13:09.042
- \row \i "h:m:s ap" \i 2:13:9 pm
+ \header \li Format \li Result
+ \row \li "dd.MM.yyyy" \li 21.05.2001
+ \row \li "ddd MMMM d yy" \li Tue May 21 01
+ \row \li "hh:mm:ss.zzz" \li 14:13:09.042
+ \row \li "h:m:s ap" \li 2:13:9 pm
\endtable
*/
QScriptValue QDeclarativeEnginePrivate::formatDateTime(QScriptContext*ctxt, QScriptEngine*engine)
diff --git a/src/declarative/qml/qdeclarativeextensionplugin.cpp b/src/declarative/qml/qdeclarativeextensionplugin.cpp
index 48c08e13..16345881 100644
--- a/src/declarative/qml/qdeclarativeextensionplugin.cpp
+++ b/src/declarative/qml/qdeclarativeextensionplugin.cpp
@@ -57,10 +57,10 @@ QT_BEGIN_NAMESPACE
To write a QML extension plugin:
\list
- \o Subclass QDeclarativeExtensionPlugin, implement registerTypes() method
+ \li Subclass QDeclarativeExtensionPlugin, implement registerTypes() method
to register types using qmlRegisterType(), and export the class using the Q_EXPORT_PLUGIN2() macro
- \o Write an appropriate project file for the plugin
- \o Create a \l{Writing a qmldir file}{qmldir file} to describe the plugin
+ \li Write an appropriate project file for the plugin
+ \li Create a \l{Writing a qmldir file}{qmldir file} to describe the plugin
\endlist
QML extension plugins can be used to provide either application-specific or
diff --git a/src/declarative/qml/qdeclarativeimageprovider.cpp b/src/declarative/qml/qdeclarativeimageprovider.cpp
index 17eae184..20f5fb6a 100644
--- a/src/declarative/qml/qdeclarativeimageprovider.cpp
+++ b/src/declarative/qml/qdeclarativeimageprovider.cpp
@@ -58,12 +58,12 @@ public:
in QML applications. It allows images in QML to be:
\list
- \o Loaded using QPixmaps rather than actual image files
- \o Loaded asynchronously in a separate thread, if imageType() is \l{QDeclarativeImageProvider::ImageType}{ImageType::Image}
+ \li Loaded using QPixmaps rather than actual image files
+ \li Loaded asynchronously in a separate thread, if imageType() is \l{QDeclarativeImageProvider::ImageType}{ImageType::Image}
\endlist
To specify that an image should be loaded by an image provider, use the
- \bold {"image:"} scheme for the URL source of the image, followed by the
+ \b {"image:"} scheme for the URL source of the image, followed by the
identifiers of the image provider and the requested image. For example:
\qml
diff --git a/src/declarative/qml/qdeclarativeimport.cpp b/src/declarative/qml/qdeclarativeimport.cpp
index 58e05b0f..25e3b830 100644
--- a/src/declarative/qml/qdeclarativeimport.cpp
+++ b/src/declarative/qml/qdeclarativeimport.cpp
@@ -221,9 +221,9 @@ void QDeclarativeImports::populateCache(QDeclarativeTypeNameCache *cache, QDecla
The given (namespace qualified) \a type is resolved to either
\list
- \o a QDeclarativeImportedNamespace stored at \a ns_return,
- \o a QDeclarativeType stored at \a type_return, or
- \o a component located at \a url_return.
+ \li a QDeclarativeImportedNamespace stored at \a ns_return,
+ \li a QDeclarativeType stored at \a type_return, or
+ \li a component located at \a url_return.
\endlist
If any return pointer is 0, the corresponding search is not done.
@@ -866,13 +866,13 @@ QString QDeclarativeImportDatabase::resolvePlugin(const QDir &qmldirPath, const
Returns the result of the merge of \a baseName with \a dir and the platform suffix.
\table
- \header \i Platform \i Valid suffixes
- \row \i Windows \i \c .dll
- \row \i Unix/Linux \i \c .so
- \row \i AIX \i \c .a
- \row \i HP-UX \i \c .sl, \c .so (HP-UXi)
- \row \i Mac OS X \i \c .dylib, \c .bundle, \c .so
- \row \i Symbian \i \c .dll
+ \header \li Platform \li Valid suffixes
+ \row \li Windows \li \c .dll
+ \row \li Unix/Linux \li \c .so
+ \row \li AIX \li \c .a
+ \row \li HP-UX \li \c .sl, \c .so (HP-UXi)
+ \row \li Mac OS X \li \c .dylib, \c .bundle, \c .so
+ \row \li Symbian \li \c .dll
\endtable
Version number on unix are ignored.
diff --git a/src/declarative/qml/qdeclarativenetworkaccessmanagerfactory.cpp b/src/declarative/qml/qdeclarativenetworkaccessmanagerfactory.cpp
index 2668b997..ea761be4 100644
--- a/src/declarative/qml/qdeclarativenetworkaccessmanagerfactory.cpp
+++ b/src/declarative/qml/qdeclarativenetworkaccessmanagerfactory.cpp
@@ -65,12 +65,12 @@ QT_BEGIN_NAMESPACE
be created in a different thread:
\list
- \o The QML engine internally handles all requests, and cleans up any
+ \li The QML engine internally handles all requests, and cleans up any
QNetworkReply objects it creates. Receiving the
QNetworkAccessManager::finished() signal in another thread may not
provide the receiver with a valid reply object if it has already
been deleted.
- \o Authentication details provided to QNetworkAccessManager::authenticationRequired()
+ \li Authentication details provided to QNetworkAccessManager::authenticationRequired()
must be provided immediately, so this signal cannot be connected as a
Qt::QueuedConnection (or as the default Qt::AutoConnection from another
thread).
diff --git a/src/declarative/qml/qdeclarativetypeloader.cpp b/src/declarative/qml/qdeclarativetypeloader.cpp
index 7b450ecb..1c624224 100644
--- a/src/declarative/qml/qdeclarativetypeloader.cpp
+++ b/src/declarative/qml/qdeclarativetypeloader.cpp
@@ -102,14 +102,14 @@ The QDeclarativeDataLoader invokes callbacks on the QDeclarativeDataBlob as data
This enum describes the status of the data blob.
\list
-\o Null The blob has not yet been loaded by a QDeclarativeDataLoader
-\o Loading The blob is loading network data. The QDeclarativeDataBlob::setData() callback has not yet been
+\li Null The blob has not yet been loaded by a QDeclarativeDataLoader
+\li Loading The blob is loading network data. The QDeclarativeDataBlob::setData() callback has not yet been
invoked or has not yet returned.
-\o WaitingForDependencies The blob is waiting for dependencies to be done before continueing. This status
+\li WaitingForDependencies The blob is waiting for dependencies to be done before continueing. This status
only occurs after the QDeclarativeDataBlob::setData() callback has been made, and when the blob has outstanding
dependencies.
-\o Complete The blob's data has been loaded and all dependencies are done.
-\o Error An error has been set on this blob.
+\li Complete The blob's data has been loaded and all dependencies are done.
+\li Error An error has been set on this blob.
\endlist
*/
@@ -119,9 +119,9 @@ dependencies.
This enum describes the type of the data blob.
\list
-\o QmlFile This is a QDeclarativeTypeData
-\o JavaScriptFile This is a QDeclarativeScriptData
-\o QmldirFile This is a QDeclarativeQmldirData
+\li QmlFile This is a QDeclarativeTypeData
+\li JavaScriptFile This is a QDeclarativeScriptData
+\li QmldirFile This is a QDeclarativeQmldirData
\endlist
*/
@@ -486,9 +486,9 @@ To complete processing, the QDeclarativeDataBlob::done() callback is invoked. d
one of these three preconditions are met.
\list 1
-\o The QDeclarativeDataBlob has no dependencies.
-\o The QDeclarativeDataBlob has an error set.
-\o All the QDeclarativeDataBlob's dependencies are themselves "done()".
+\li The QDeclarativeDataBlob has no dependencies.
+\li The QDeclarativeDataBlob has an error set.
+\li All the QDeclarativeDataBlob's dependencies are themselves "done()".
\endlist
Thus QDeclarativeDataBlob::done() will always eventually be called, even if the blob has an error set.
diff --git a/src/declarative/qml/qdeclarativeworkerscript.cpp b/src/declarative/qml/qdeclarativeworkerscript.cpp
index 30b0c99f..0cc47302 100644
--- a/src/declarative/qml/qdeclarativeworkerscript.cpp
+++ b/src/declarative/qml/qdeclarativeworkerscript.cpp
@@ -668,9 +668,9 @@ void QDeclarativeWorkerScript::setSource(const QUrl &source)
types:
\list
- \o boolean, number, string
- \o JavaScript objects and arrays
- \o ListModel objects (any other type of QObject* is not allowed)
+ \li boolean, number, string
+ \li JavaScript objects and arrays
+ \li ListModel objects (any other type of QObject* is not allowed)
\endlist
All objects and arrays are copied to the \c message. With the exception