diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 18:05:16 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-13 16:34:49 +0100 |
commit | c291efff26c13963cf98c127bfa759f89f103e48 (patch) | |
tree | 1ff72838794983592258f9718718db283834f42c /src/imports | |
parent | ada9dd41c83aad3890b8f01a98fdbeae04528eba (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: I62d203f21df63a95ee236e578b10418fd9680707
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/imports')
-rw-r--r-- | src/imports/folderlistmodel/qquickfolderlistmodel.cpp | 44 | ||||
-rw-r--r-- | src/imports/localstorage/plugin.cpp | 46 | ||||
-rw-r--r-- | src/imports/testlib/testcase.qdoc | 4 | ||||
-rw-r--r-- | src/imports/xmllistmodel/qqmlxmllistmodel.cpp | 8 |
4 files changed, 51 insertions, 51 deletions
diff --git a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp index d68d7af6d4..294fe184d2 100644 --- a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp +++ b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp @@ -208,21 +208,21 @@ void QQuickFolderListModelPrivate::_q_sortFinished(const QList<FileProperty> &li \e{Elements in the Qt.labs module are not guaranteed to remain compatible in future versions.} - \bold{import Qt.labs.folderlistmodel 1.0} + \b{import Qt.labs.folderlistmodel 1.0} The \l folder property specifies the folder to access. Information about the files and directories in the folder is supplied via the model's interface. Components access names and paths via the following roles: \list - \o \c fileName - \o \c filePath - \o \c fileBaseName - \o \c fileSuffix - \o \c fileSize - \o \c fileModified - \o \c fileAccessed - \o \c fileIsDir + \li \c fileName + \li \c filePath + \li \c fileBaseName + \li \c fileSuffix + \li \c fileSize + \li \c fileModified + \li \c fileAccessed + \li \c fileIsDir \endlist Additionally a file entry can be differentiated from a folder entry via the @@ -493,11 +493,11 @@ void QQuickFolderListModel::componentComplete() The \a sortField property contains field to use for sorting. sortField may be one of: \list - \o Unsorted - no sorting is applied. - \o Name - sort by filename - \o LastModified - sort by time modified - \o Size - sort by file size - \o Type - sort by file type (extension) + \li Unsorted - no sorting is applied. + \li Name - sort by filename + \li LastModified - sort by time modified + \li Size - sort by file size + \li Type - sort by file type (extension) \endlist \sa sortReversed @@ -672,14 +672,14 @@ void QQuickFolderListModel::setShowOnlyReadable(bool on) are available. \list - \o \c fileName - \o \c filePath - \o \c fileBaseName - \o \c fileSuffix - \o \c fileSize - \o \c fileModified - \o \c fileAccessed - \o \c fileIsDir + \li \c fileName + \li \c filePath + \li \c fileBaseName + \li \c fileSuffix + \li \c fileSize + \li \c fileModified + \li \c fileAccessed + \li \c fileIsDir \endlist */ QVariant QQuickFolderListModel::get(int idx, const QString &property) const diff --git a/src/imports/localstorage/plugin.cpp b/src/imports/localstorage/plugin.cpp index 7c55225ed1..0187d06e6a 100644 --- a/src/imports/localstorage/plugin.cpp +++ b/src/imports/localstorage/plugin.cpp @@ -480,9 +480,9 @@ import QtQuick.LocalStorage 2.0 as LS db = LS.openDatabaseSync(identifier, version, description, estimated_size, callback(db)) \endcode -The above code returns the database identified by \i identifier. If the database does not already exist, it -is created, and the function \i callback is called with the database as a parameter. \i description -and \i estimated_size are written to the INI file (described below), but are otherwise currently +The above code returns the database identified by \e identifier. If the database does not already exist, it +is created, and the function \e callback is called with the database as a parameter. \e description +and \e estimated_size are written to the INI file (described below), but are otherwise currently unused. May throw exception with code property SQLException.DATABASE_ERR, or SQLException.VERSION_ERR. @@ -490,51 +490,51 @@ May throw exception with code property SQLException.DATABASE_ERR, or SQLExceptio When a database is first created, an INI file is also created specifying its characteristics: \table -\header \o \bold {Key} \o \bold {Value} -\row \o Name \o The name of the database passed to \c openDatabase() -\row \o Version \o The version of the database passed to \c openDatabase() -\row \o Description \o The description of the database passed to \c openDatabase() -\row \o EstimatedSize \o The estimated size (in bytes) of the database passed to \c openDatabase() -\row \o Driver \o Currently "QSQLITE" +\header \li \b {Key} \li \b {Value} +\row \li Name \li The name of the database passed to \c openDatabase() +\row \li Version \li The version of the database passed to \c openDatabase() +\row \li Description \li The description of the database passed to \c openDatabase() +\row \li EstimatedSize \li The estimated size (in bytes) of the database passed to \c openDatabase() +\row \li Driver \li Currently "QSQLITE" \endtable This data can be used by application tools. \section3 db.changeVersion(from, to, callback(tx)) -This method allows you to perform a \i{Scheme Upgrade}. +This method allows you to perform a \e{Scheme Upgrade}. -If the current version of \i db is not \i from, then an exception is thrown. +If the current version of \e db is not \e from, then an exception is thrown. -Otherwise, a database transaction is created and passed to \i callback. In this function, -you can call \i executeSql on \i tx to upgrade the database. +Otherwise, a database transaction is created and passed to \e callback. In this function, +you can call \e executeSql on \e tx to upgrade the database. May throw exception with code property SQLException.DATABASE_ERR or SQLException.UNKNOWN_ERR. \section3 db.transaction(callback(tx)) -This method creates a read/write transaction and passed to \i callback. In this function, -you can call \i executeSql on \i tx to read and modify the database. +This method creates a read/write transaction and passed to \e callback. In this function, +you can call \e executeSql on \e tx to read and modify the database. If the callback throws exceptions, the transaction is rolled back. \section3 db.readTransaction(callback(tx)) -This method creates a read-only transaction and passed to \i callback. In this function, -you can call \i executeSql on \i tx to read the database (with SELECT statements). +This method creates a read-only transaction and passed to \e callback. In this function, +you can call \e executeSql on \e tx to read the database (with SELECT statements). \section3 results = tx.executeSql(statement, values) -This method executes a SQL \i statement, binding the list of \i values to SQL positional parameters ("?"). +This method executes a SQL \e statement, binding the list of \e values to SQL positional parameters ("?"). It returns a results object, with the following properties: \table -\header \o \bold {Type} \o \bold {Property} \o \bold {Value} \o \bold {Applicability} -\row \o int \o rows.length \o The number of rows in the result \o SELECT -\row \o var \o rows.item(i) \o Function that returns row \i i of the result \o SELECT -\row \o int \o rowsAffected \o The number of rows affected by a modification \o UPDATE, DELETE -\row \o string \o insertId \o The id of the row inserted \o INSERT +\header \li \b {Type} \li \b {Property} \li \b {Value} \li \b {Applicability} +\row \li int \li rows.length \li The number of rows in the result \li SELECT +\row \li var \li rows.item(i) \li Function that returns row \e i of the result \li SELECT +\row \li int \li rowsAffected \li The number of rows affected by a modification \li UPDATE, DELETE +\row \li string \li insertId \li The id of the row inserted \li INSERT \endtable May throw exception with code property SQLException.DATABASE_ERR, SQLException.SYNTAX_ERR, or SQLException.UNKNOWN_ERR. diff --git a/src/imports/testlib/testcase.qdoc b/src/imports/testlib/testcase.qdoc index d8a20e4fc7..f928cdaa44 100644 --- a/src/imports/testlib/testcase.qdoc +++ b/src/imports/testlib/testcase.qdoc @@ -180,7 +180,7 @@ and mouseMove() methods can be used to simulate mouse events in a similar fashion. - \bold{Note:} keyboard and mouse events can only be delivered once the + \b{Note:} keyboard and mouse events can only be delivered once the main window has been shown. Attempts to deliver events before then will fail. Use the \l when and windowShown properties to track when the main window has been shown. @@ -446,7 +446,7 @@ focused item. If \a delay is larger than 0, the test will wait for \a delay milliseconds. - \bold{Note:} At some point you should release the key using keyRelease(). + \b{Note:} At some point you should release the key using keyRelease(). \sa keyRelease(), keyClick() */ diff --git a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp index 1377859b5e..22072dc75a 100644 --- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp +++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp @@ -909,10 +909,10 @@ QQmlV8Handle QQuickXmlListModel::get(int index) const Specifies the model loading status, which can be one of the following: \list - \o XmlListModel.Null - No XML data has been set for this model. - \o XmlListModel.Ready - The XML data has been loaded into the model. - \o XmlListModel.Loading - The model is in the process of reading and loading XML data. - \o XmlListModel.Error - An error occurred while the model was loading. See errorString() for details + \li XmlListModel.Null - No XML data has been set for this model. + \li XmlListModel.Ready - The XML data has been loaded into the model. + \li XmlListModel.Loading - The model is in the process of reading and loading XML data. + \li XmlListModel.Error - An error occurred while the model was loading. See errorString() for details about the error. \endlist |