From 653edc8396f877ea4313bf5f9419487dcc19dfd6 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Mon, 19 Sep 2016 13:47:44 +0200 Subject: Fix documentation for new WebEngineDownloadItem::type enumeration Change-Id: Iaa6d1daa66d6c49c0545d36041485c7156003805 Reviewed-by: Leena Miettinen --- src/webengine/api/qquickwebenginedownloaditem.cpp | 17 ++++++++++------- src/webenginewidgets/api/qwebenginedownloaditem.cpp | 17 ++++++++++------- 2 files changed, 20 insertions(+), 14 deletions(-) (limited to 'src') diff --git a/src/webengine/api/qquickwebenginedownloaditem.cpp b/src/webengine/api/qquickwebenginedownloaditem.cpp index f38af3923..d557000f1 100644 --- a/src/webengine/api/qquickwebenginedownloaditem.cpp +++ b/src/webengine/api/qquickwebenginedownloaditem.cpp @@ -307,14 +307,17 @@ void QQuickWebEngineDownloadItem::setSavePageFormat(QQuickWebEngineDownloadItem: Describes the requested download's type. - \value Attachment The web server's response includes a \c Content-Disposition header with the \c attachment directive. - If \c Content-Disposition is present in the reply, the web server is indicating that - the client should prompt the user to save the content regardless of the content type. + \value WebEngineDownloadItem.Attachment The web server's response includes a + \c Content-Disposition header with the \c attachment directive. If \c Content-Disposition + is present in the reply, the web server is indicating that the client should prompt the + user to save the content regardless of the content type. See \l {RFC 2616 section 19.5.1} for details. - \value DownloadAttribute The user clicked the hyperlink. - See \l {HTML download Attribute} for details. - \value UserRequested The user initiated the download. - \value SavePage The user saved a web page. + \value WebEngineDownloadItem.DownloadAttribute The user clicked a link with the \c download + attribute. See \l {HTML download Attribute} for details. + \value WebEngineDownloadItem.UserRequested The user initiated the download, for example by + selecting a web action. + \value WebEngineDownloadItem.SavePage Saving of the current page was requested (for example by + the \l{WebEngineView::WebAction}{WebEngineView.SavePage} web action). */ QQuickWebEngineDownloadItem::DownloadType QQuickWebEngineDownloadItem::type() const diff --git a/src/webenginewidgets/api/qwebenginedownloaditem.cpp b/src/webenginewidgets/api/qwebenginedownloaditem.cpp index 6f7865a50..36e40df29 100644 --- a/src/webenginewidgets/api/qwebenginedownloaditem.cpp +++ b/src/webenginewidgets/api/qwebenginedownloaditem.cpp @@ -224,14 +224,17 @@ quint32 QWebEngineDownloadItem::id() const Describes the requested download's type. - \value Attachment The web server's response includes a \c Content-Disposition header with the \c attachment directive. - If \c Content-Disposition is present in the reply, the web server is indicating that - the client should prompt the user to save the content regardless of the content type. + \value Attachment The web server's response includes a + \c Content-Disposition header with the \c attachment directive. If \c Content-Disposition + is present in the reply, the web server is indicating that the client should prompt the + user to save the content regardless of the content type. See \l {RFC 2616 section 19.5.1} for details. - \value DownloadAttribute The user clicked the hyperlink. - See \l {HTML download Attribute} for details. - \value UserRequested The user initiated the download. - \value SavePage The user saved a web page. + \value DownloadAttribute The user clicked a link with the \c download + attribute. See \l {HTML download Attribute} for details. + \value UserRequested The user initiated the download, for example by + selecting a web action. + \value SavePage Saving of the current page was requested (for example by + the \l{QWebEnginePage::WebAction}{QWebEnginePage::SavePage} web action). */ /*! -- cgit v1.2.3