diff options
| author | Bea Lam <bea.lam@nokia.com> | 2012-05-28 11:56:24 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-31 10:40:41 +0200 |
| commit | 4c671c046e8140bfb8372aab2c38aabe82b102b0 (patch) | |
| tree | 7a70a75a553dcc806372a6b43ea39da05191db8a /src/imports | |
| parent | 0c7669b241aae96fca97acae0b628e627d5bfc4e (diff) | |
Fix doc snippets paths and parsing errors
qtqml.qdocconf and qtquick.qdocconf now refer to the correct
snippets and source directories.
Snippet paths in .qdoc and .cpp files have been updated to refer to
the new shortened path references, e.g. \snippet qml/file.cpp instead of
\snippet doc/src/snippets/qml/file.cpp.
This also deletes snippets from src/qml/doc/snippets that belonged under
src/quick/doc/snippets (and were already duplicated there anyway) and
restores some snippet files that shouldn't have been deleted.
Also fixes some inline snippets to use \code .. \endcode instead of
\qml .. \endqml as they contained javascript or partial QML
snippets that were causing parsing errors from qdoc.
There are still snippet errors arising from qmlintro.qdoc as the
qmlintro snippets directory that it refers to cannot be located.
There are also two references to a removed snippet identifier in
examples/qml/cppextensions/plugins/plugin.cpp that need to be fixed
in conjunction with the related docs in a later commit as the relevant
code has changed and the docs are now invalid.
Task-number: QTBUG-25721
Change-Id: I50c665245a74c140470c58a32546591d187dfe4b
Reviewed-by: Chris Adams <christopher.adams@nokia.com>
Diffstat (limited to 'src/imports')
| -rw-r--r-- | src/imports/folderlistmodel/qquickfolderlistmodel.cpp | 2 | ||||
| -rw-r--r-- | src/imports/localstorage/plugin.cpp | 2 | ||||
| -rw-r--r-- | src/imports/xmllistmodel/qqmlxmllistmodel.cpp | 6 |
3 files changed, 5 insertions, 5 deletions
diff --git a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp index 218d7955e1..de3baf1d17 100644 --- a/src/imports/folderlistmodel/qquickfolderlistmodel.cpp +++ b/src/imports/folderlistmodel/qquickfolderlistmodel.cpp @@ -250,7 +250,7 @@ void QQuickFolderListModelPrivate::_q_sortFinished(const QList<FileProperty> &li The following example shows a FolderListModel being used to provide a list of QML files in a \l ListView: - \snippet doc/src/snippets/qml/folderlistmodel.qml 0 + \snippet qml/folderlistmodel.qml 0 \section1 Path Separators diff --git a/src/imports/localstorage/plugin.cpp b/src/imports/localstorage/plugin.cpp index e3e9fa4cd3..b1466a1a73 100644 --- a/src/imports/localstorage/plugin.cpp +++ b/src/imports/localstorage/plugin.cpp @@ -466,7 +466,7 @@ Database connections are automatically closed during Javascript garbage collecti The API can be used from JavaScript functions in your QML: -\snippet declarative/sqllocalstorage/hello.qml 0 +\snippet qml/sqllocalstorage/hello.qml 0 The API conforms to the Synchronous API of the HTML5 Web Database API, \link http://www.w3.org/TR/2009/WD-webdatabase-20091029/ W3C Working Draft 29 October 2009\endlink. diff --git a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp index 221fdaea42..7ae94bb5af 100644 --- a/src/imports/xmllistmodel/qqmlxmllistmodel.cpp +++ b/src/imports/xmllistmodel/qqmlxmllistmodel.cpp @@ -111,12 +111,12 @@ typedef QPair<int, int> QQuickXmlListRange; For example, if there is an XML document like this: - \quotefile doc/src/snippets/qml/xmlrole.xml + \quotefile qml/xmlrole.xml Here are some valid XPath expressions for XmlRole queries on this document: - \snippet doc/src/snippets/qml/xmlrole.qml 0 + \snippet qml/xmlrole.qml 0 \dots 4 - \snippet doc/src/snippets/qml/xmlrole.qml 1 + \snippet qml/xmlrole.qml 1 See the \l{http://www.w3.org/TR/xpath20/}{W3C XPath 2.0 specification} for more information. */ |