diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-08-27 12:00:29 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-08-28 07:43:49 +0000 |
| commit | 70e8ccc3e14c3e44e216a32d723ac704fb017515 (patch) | |
| tree | 7e15c64b187fe9a4af2acd527b0eedd7301881de /src | |
| parent | d0ce6ce776852c1fab3d349ee709e5ac49f18796 (diff) | |
Doc: edit WebEngineLoadRequest docs
- Add missing documentation
- Replace "class" with "type"
- Use standard phrasing
- Edit for grammar and style
Change-Id: I35bcb3c84e87257d56ee5d89847f8ecf302b205b
Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/webengine/api/qquickwebengineloadrequest.cpp | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/src/webengine/api/qquickwebengineloadrequest.cpp b/src/webengine/api/qquickwebengineloadrequest.cpp index c85d0d76f..e94fa7eb9 100644 --- a/src/webengine/api/qquickwebengineloadrequest.cpp +++ b/src/webengine/api/qquickwebengineloadrequest.cpp @@ -62,10 +62,10 @@ public: \inqmlmodule QtWebEngine 1.0 \since QtWebEngine 1.0 - \brief A utility class for the WebEngineView::loadingChanged signal. + \brief A utility type for the WebEngineView::loadingChanged signal. - This class contains information about a requested load of a web page, such as the URL and - current loading status (started, finished, failed). + Contains information about a request for loading a web page, such as the URL and + current loading status (started, succeeded, failed). \sa WebEngineView::loadingChanged */ @@ -81,7 +81,7 @@ QQuickWebEngineLoadRequest::~QQuickWebEngineLoadRequest() /*! \qmlproperty url WebEngineLoadRequest::url - \brief The URL of the load request. + \brief Holds the URL of the load request. */ QUrl QQuickWebEngineLoadRequest::url() const { @@ -92,11 +92,11 @@ QUrl QQuickWebEngineLoadRequest::url() const /*! \qmlproperty enumeration WebEngineLoadRequest::status - This enumeration represents the load status of a web page load request. + This enumeration represents the load status of a web page load request: - \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. + \value WebEngineView::LoadStartedStatus Page is currently loading. + \value WebEngineView::LoadSucceededStatus Page has been loaded with success. + \value WebEngineView::LoadFailedStatus Page could not be loaded. \sa WebEngineView::loadingChanged */ @@ -108,6 +108,7 @@ QQuickWebEngineView::LoadStatus QQuickWebEngineLoadRequest::status() const /*! \qmlproperty string WebEngineLoadRequest::errorString + \brief Holds the error message. */ QString QQuickWebEngineLoadRequest::errorString() const { @@ -123,6 +124,7 @@ QQuickWebEngineView::ErrorDomain QQuickWebEngineLoadRequest::errorDomain() const /*! \qmlproperty int WebEngineLoadRequest::errorCode + \brief Holds the error code. */ int QQuickWebEngineLoadRequest::errorCode() const { |