summaryrefslogtreecommitdiffstats
path: root/src/webengine/api/qquickwebengineloadrequest.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-08-31 21:18:49 +0200
committerJerome Pasion <jerome.pasion@digia.com>2014-09-29 21:35:47 +0200
commitfa05ae77ded8c5ddc109bf7acfcb8b833b6b80f9 (patch)
tree1d1f1e70560f6a27828c3bf56d5881e7d2ac9dd5 /src/webengine/api/qquickwebengineloadrequest.cpp
parent390391c8138b0138954da0d50537dbb138758bd9 (diff)
Doc: Edited docs according to writing guidelines.
-added \since and added commands such as \readonly -converted enum values to use \value -edited language and other minor issues. -only the main Qt WebEngine, the widget docs will be edited later. Change-Id: Ifbb76a6472b5efede15daebc78d605b8b449d957 Task-number: QTBUG-40757 Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/webengine/api/qquickwebengineloadrequest.cpp')
-rw-r--r--src/webengine/api/qquickwebengineloadrequest.cpp18
1 files changed, 8 insertions, 10 deletions
diff --git a/src/webengine/api/qquickwebengineloadrequest.cpp b/src/webengine/api/qquickwebengineloadrequest.cpp
index 7e207ea3f..a29381af6 100644
--- a/src/webengine/api/qquickwebengineloadrequest.cpp
+++ b/src/webengine/api/qquickwebengineloadrequest.cpp
@@ -60,13 +60,14 @@ public:
\qmltype WebEngineLoadRequest
\instantiates QQuickWebEngineLoadRequest
\inqmlmodule QtWebEngine 1.0
+ \since QtWebEngine 1.0
\brief A utility class for the WebEngineView::loadingChanged signal.
- This class contains information about a requested load of a web page, like the URL and
+ This class contains information about a requested load of a web page, such as the URL and
current loading status (started, finished, failed).
- \sa WebEngineView::onLoadingChanged
+ \sa WebEngineView::loadingChanged
*/
QQuickWebEngineLoadRequest::QQuickWebEngineLoadRequest(const QUrl& url, QQuickWebEngineView::LoadStatus status, const QString& errorString, int errorCode, QQuickWebEngineView::ErrorDomain errorDomain, QObject* parent)
: QObject(parent)
@@ -91,16 +92,13 @@ QUrl QQuickWebEngineLoadRequest::url() const
/*!
\qmlproperty enumeration WebEngineLoadRequest::status
- The load status of a web page load request.
+ This enumeration represents the load status of a web page load request.
- \list
- \li WebEngineView::LoadStartedStatus - the page is currently loading.
- \li WebEngineView::LoadSucceededStatus - the page has been loaded with success.
- \li WebEngineView::LoadFailedStatus - the page has failed loading.
- \endlist
+ \value WebEngineView::LoadStartedStatus The page is currently loading.
+ \value WebEngineView::LoadSucceededStatus The page has been loaded with success.
+ \value WebEngineView::LoadFailedStatus The page has failed loading.
- \sa WebEngineLoadRequest
- \sa WebEngineView::onLoadingChanged
+ \sa WebEngineView::loadingChanged
*/
QQuickWebEngineView::LoadStatus QQuickWebEngineLoadRequest::status() const
{