From bde1c73d92dc353f2d5c4e93425d8e86bf672caa Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 8 Aug 2016 15:30:23 +0200 Subject: Doc: Add type name to enumeration values to follow the doc convention Change-Id: I86eea3a64a38f6ec9984f663499abffa03cd9eb2 Reviewed-by: Allan Sandfeld Jensen --- .../api/qquickwebenginecertificateerror.cpp | 43 +++++--- src/webengine/api/qquickwebenginedownloaditem.cpp | 8 +- src/webengine/api/qquickwebengineloadrequest.cpp | 7 +- src/webengine/api/qquickwebengineprofile.cpp | 10 +- src/webengine/api/qquickwebenginescript.cpp | 12 +-- src/webengine/doc/src/webengineview.qdoc | 116 +++++++++++---------- 6 files changed, 107 insertions(+), 89 deletions(-) (limited to 'src') diff --git a/src/webengine/api/qquickwebenginecertificateerror.cpp b/src/webengine/api/qquickwebenginecertificateerror.cpp index 7b06696d2..ceb5842bd 100644 --- a/src/webengine/api/qquickwebenginecertificateerror.cpp +++ b/src/webengine/api/qquickwebenginecertificateerror.cpp @@ -160,20 +160,35 @@ QUrl QQuickWebEngineCertificateError::url() const The type of the error. - \value SslPinnedKeyNotInCertificateChain The certificate did not match the built-in public keys - pinned for the host name. - \value CertificateCommonNameInvalid The certificate's common name did not match the host name. - \value CertificateDateInvalid The certificate is not valid at the current date and time. - \value CertificateAuthorityInvalid The certificate is not signed by a trusted authority. - \value CertificateContainsErrors The certificate contains errors. - \value CertificateNoRevocationMechanism The certificate has no mechanism for determining if it has been revoked. - \value CertificateUnableToCheckRevocation Revocation information for the certificate is not available. - \value CertificateRevoked The certificate has been revoked. - \value CertificateInvalid The certificate is invalid. - \value CertificateWeakSignatureAlgorithm The certificate is signed using a weak signature algorithm. - \value CertificateNonUniqueName The host name specified in the certificate is not unique. - \value CertificateWeakKey The certificate contains a weak key. - \value CertificateNameConstraintViolation The certificate claimed DNS names that are in violation of name constraints. + \value WebEngineCertificateError.SslPinnedKeyNotInCertificateChain + The certificate did not match the built-in public keys pinned for + the host name. + \value WebEngineCertificateError.CertificateCommonNameInvalid + The certificate's common name did not match the host name. + \value WebEngineCertificateError.CertificateDateInvalid + The certificate is not valid at the current date and time. + \value WebEngineCertificateError.CertificateAuthorityInvalid + The certificate is not signed by a trusted authority. + \value WebEngineCertificateError.CertificateContainsErrors + The certificate contains errors. + \value WebEngineCertificateError.CertificateNoRevocationMechanism + The certificate has no mechanism for determining if it has been + revoked. + \value WebEngineCertificateError.CertificateUnableToCheckRevocation + Revocation information for the certificate is not available. + \value WebEngineCertificateError.CertificateRevoked + The certificate has been revoked. + \value WebEngineCertificateError.CertificateInvalid + The certificate is invalid. + \value WebEngineCertificateError.CertificateWeakSignatureAlgorithm + The certificate is signed using a weak signature algorithm. + \value WebEngineCertificateError.CertificateNonUniqueName + The host name specified in the certificate is not unique. + \value WebEngineCertificateError.CertificateWeakKey + The certificate contains a weak key. + \value WebEngineCertificateError.CertificateNameConstraintViolation + The certificate claimed DNS names that are in violation of name + constraints. */ QQuickWebEngineCertificateError::Error QQuickWebEngineCertificateError::error() const { diff --git a/src/webengine/api/qquickwebenginedownloaditem.cpp b/src/webengine/api/qquickwebenginedownloaditem.cpp index 8e5c0e160..4e71c750d 100644 --- a/src/webengine/api/qquickwebenginedownloaditem.cpp +++ b/src/webengine/api/qquickwebenginedownloaditem.cpp @@ -174,13 +174,13 @@ quint32 QQuickWebEngineDownloadItem::id() const Describes the state of the download: - \value DownloadRequested + \value WebEngineDownloadItem.DownloadRequested Download has been requested, but it has not been accepted yet. - \value DownloadInProgress + \value WebEngineDownloadItem.DownloadInProgress Download is in progress. - \value DownloadCompleted + \value WebEngineDownloadItem.DownloadCompleted Download completed successfully. - \value DownloadInterrupted + \value WebEngineDownloadItem.DownloadInterrupted Download has been interrupted (by the server or because of lost connectivity). */ diff --git a/src/webengine/api/qquickwebengineloadrequest.cpp b/src/webengine/api/qquickwebengineloadrequest.cpp index e39d7b4d1..3dbbb852c 100644 --- a/src/webengine/api/qquickwebengineloadrequest.cpp +++ b/src/webengine/api/qquickwebengineloadrequest.cpp @@ -94,9 +94,10 @@ QUrl QQuickWebEngineLoadRequest::url() const This enumeration represents the load status of a web page load request: - \value WebEngineView::LoadStartedStatus Page is currently loading. - \value WebEngineView::LoadSucceededStatus Page has been loaded with success. - \value WebEngineView::LoadFailedStatus Page could not be loaded. + \value WebEngineLoadRequest.LoadStartedStatus Page is currently loading. + \value WebEngineLoadRequest.LoadSucceededStatus + Page has been loaded with success. + \value WebEngineLoadRequest.LoadFailedStatus Page could not be loaded. \sa WebEngineView::loadingChanged */ diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp index 2e20d0f7b..013696f7e 100644 --- a/src/webengine/api/qquickwebengineprofile.cpp +++ b/src/webengine/api/qquickwebengineprofile.cpp @@ -447,10 +447,10 @@ void QQuickWebEngineProfile::setHttpUserAgent(const QString &userAgent) This enumeration describes the type of the HTTP cache: - \value MemoryHttpCache + \value WebEngineProfile.MemoryHttpCache Uses an in-memory cache. This is the only setting possible if offTheRecord is set or no persistentStoragePath is available. - \value DiskHttpCache + \value WebEngineProfile.DiskHttpCache Uses a disk cache. This is the default value. */ @@ -482,13 +482,13 @@ void QQuickWebEngineProfile::setHttpCacheType(QQuickWebEngineProfile::HttpCacheT This enumeration describes the policy of cookie persistency: - \value NoPersistentCookies + \value WebEngineProfile.NoPersistentCookies Both session and persistent cookies are stored in memory. This is the only setting possible if offTheRecord is set or no persistentStoragePath is available. - \value AllowPersistentCookies + \value WebEngineProfile.AllowPersistentCookies Cookies marked persistent are saved to and restored from disk, whereas session cookies are only stored to disk for crash recovery. This is the default setting. - \value ForcePersistentCookies + \value WebEngineProfile.ForcePersistentCookies Both session and persistent cookies are saved to and restored from disk. */ diff --git a/src/webengine/api/qquickwebenginescript.cpp b/src/webengine/api/qquickwebenginescript.cpp index 6d698c3c6..c57c0f21b 100644 --- a/src/webengine/api/qquickwebenginescript.cpp +++ b/src/webengine/api/qquickwebenginescript.cpp @@ -156,13 +156,13 @@ ASSERT_ENUMS_MATCH(QQuickWebEngineScript::DocumentCreation, UserScript::Document The point in the loading process at which the script will be executed. The default value is \c Deferred. - \value DocumentCreation + \value WebEngineScript.DocumentCreation The script will be executed as soon as the document is created. This is not suitable for any DOM operation. - \value DocumentReady + \value WebEngineScript.DocumentReady The script will run as soon as the DOM is ready. This is equivalent to the \c DOMContentLoaded event firing in JavaScript. - \value Deferred + \value WebEngineScript.Deferred The script will run when the page load finishes, or 500 ms after the document is ready, whichever comes first. */ @@ -177,13 +177,13 @@ QQuickWebEngineScript::InjectionPoint QQuickWebEngineScript::injectionPoint() co The world ID defining which isolated world the script is executed in. - \value MainWorld + \value WebEngineScript.MainWorld The world used by the page's web contents. It can be useful in order to expose custom functionality to web contents in certain scenarios. - \value ApplicationWorld + \value WebEngineScript.ApplicationWorld The default isolated world used for application level functionality implemented in JavaScript. - \value UserWorld + \value WebEngineScript.UserWorld The first isolated world to be used by scripts set by users if the application is not making use of more worlds. As a rule of thumb, if that functionality is exposed to the application users, each individual script should probably get its own isolated world. diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 1620f3031..322580c75 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -612,18 +612,18 @@ Describes various high-level error types: - \value WebEngineView::NoErrorDomain - \value WebEngineView::InternalErrorDomain + \value WebEngineView.NoErrorDomain + \value WebEngineView.InternalErrorDomain Content fails to be interpreted by Qt WebEngine. - \value WebEngineView::ConnectionErrorDomain + \value WebEngineView.ConnectionErrorDomain Error results from faulty network connection. - \value WebEngineView::CertificateErrorDomain + \value WebEngineView.CertificateErrorDomain Error related to the SSL/TLS certficate. - \value WebEngineView::HttpErrorDomain + \value WebEngineView.HttpErrorDomain Error related to the HTTP connection. - \value WebEngineView::FtpErrorDomain + \value WebEngineView.FtpErrorDomain Error related to the FTP connection. - \value WebEngineView::DnsErrorDomain + \value WebEngineView.DnsErrorDomain Error related to the DNS connection. */ @@ -632,11 +632,11 @@ Indicates the severity of a JavaScript console message: - \value InfoMessageLevel + \value WebEngineView.InfoMessageLevel Message is purely informative and can safely be ignored. - \value WarningMessageLevel + \value WebEngineView.WarningMessageLevel Message indicates there might be a problem that may need attention. - \value ErrorMessageLevel + \value WebEngineView.ErrorMessageLevel Message indicates there has been an error. */ @@ -645,11 +645,11 @@ Reflects a page's load status: - \value LoadStartedStatus + \value WebEngineView.LoadStartedStatus Page is currently loading. - \value LoadSucceededStatus + \value WebEngineView.LoadSucceededStatus Page has successfully loaded, and is not currently loading. - \value LoadFailedStatus + \value WebEngineView.LoadFailedStatus Page has failed to load, and is not currently loading. */ @@ -658,16 +658,16 @@ Describes how to open a new view: - \value WebEngineView::NewViewInWindow + \value WebEngineView.NewViewInWindow In a separate Window. - \value WebEngineView::NewViewInTab + \value WebEngineView.NewViewInTab In a tab of the same window. - \value WebEngineView::NewViewInDialog + \value WebEngineView.NewViewInDialog In a Window without a tab bar, toolbar, or URL bar. - \value WebEngineView::NewViewInBackgroundTab + \value WebEngineView.NewViewInBackgroundTab In a tab of the same window, without hiding the currently visible web engine view. - \sa WebEngineNewViewRequest::destination + \sa {WebEngineNewViewRequest::destination}{WebEngineNewViewRequest.destination} */ /*! @@ -676,8 +676,10 @@ Describes the options available to the findText() function. The options can be OR-ed together from the following list: - \value FindBackward Searches backwards instead of forwards. - \value FindCaseSensitively By default findText() works case insensitive. Specifying + \value WebEngineView.FindBackward + Searches backwards instead of forwards. + \value WebEngineView.FindFlags FindCaseSensitively + By default findText() works case insensitive. Specifying this option changes the behavior to a case sensitive find operation. \sa findText() @@ -689,13 +691,13 @@ Describes the status with which the render process terminated: - \value NormalTerminationStatus + \value WebEngineView.NormalTerminationStatus The render process terminated normally. - \value AbnormalTerminationStatus + \value WebEngineView.AbnormalTerminationStatus The render process terminated with a non-zero exit status. - \value CrashedTerminationStatus + \value WebEngineView.CrashedTerminationStatus The render process crashed, for example because of a segmentation fault. - \value KilledTerminationStatus + \value WebEngineView.KilledTerminationStatus The render process was killed, for example by \c SIGKILL or task manager kill. */ @@ -705,68 +707,68 @@ Describes the types of action that can be performed on a web page: - \value NoWebAction + \value WebEngineView.NoWebAction No action is triggered. - \value Back + \value WebEngineView.Back Navigate back in the history of navigated links. - \value Forward + \value WebEngineView.Forward Navigate forward in the history of navigated links. - \value Stop + \value WebEngineView.Stop Stop loading the current page. - \value Reload + \value WebEngineView.Reload Reload the current page. - \value ReloadAndBypassCache + \value WebEngineView.ReloadAndBypassCache Reload the current page, but do not use any local cache. - \value Cut + \value WebEngineView.Cut Cut the content currently selected into the clipboard. - \value Copy + \value WebEngineView.Copy Copy the content currently selected into the clipboard. - \value Paste + \value WebEngineView.Paste Paste content from the clipboard. - \value Undo + \value WebEngineView.Undo Undo the last editing action. - \value Redo + \value WebEngineView.Redo Redo the last editing action. - \value SelectAll + \value WebEngineView.SelectAll Select all content. - \value PasteAndMatchStyle + \value WebEngineView.PasteAndMatchStyle Paste content from the clipboard with current style. - \value OpenLinkInThisWindow + \value WebEngineView.OpenLinkInThisWindow Open the current link in the current window. (Added in Qt 5.6) - \value OpenLinkInNewWindow + \value WebEngineView.OpenLinkInNewWindow Open the current link in a new window. (Added in Qt 5.6) - \value OpenLinkInNewTab + \value WebEngineView.OpenLinkInNewTab Open the current link in a new tab. (Added in Qt 5.6) - \value CopyLinkToClipboard + \value WebEngineView.CopyLinkToClipboard Copy the current link to the clipboard. (Added in Qt 5.6) - \value CopyImageToClipboard + \value WebEngineView.CopyImageToClipboard Copy the clicked image to the clipboard. (Added in Qt 5.6) - \value CopyImageUrlToClipboard + \value WebEngineView.CopyImageUrlToClipboard Copy the clicked image's URL to the clipboard. (Added in Qt 5.6) - \value CopyMediaUrlToClipboard + \value WebEngineView.CopyMediaUrlToClipboard Copy the hovered audio or video's URL to the clipboard. (Added in Qt 5.6) - \value ToggleMediaControls + \value WebEngineView.ToggleMediaControls Toggle between showing and hiding the controls for the hovered audio or video element. (Added in Qt 5.6) - \value ToggleMediaLoop + \value WebEngineView.ToggleMediaLoop Toggle whether the hovered audio or video should loop on completetion or not. (Added in Qt 5.6) - \value ToggleMediaPlayPause + \value WebEngineView.ToggleMediaPlayPause Toggle the play/pause state of the hovered audio or video element. (Added in Qt 5.6) - \value ToggleMediaMute + \value WebEngineView.ToggleMediaMute Mute or unmute the hovered audio or video element. (Added in Qt 5.6) - \value DownloadLinkToDisk + \value WebEngineView.DownloadLinkToDisk Download the current link to the disk. To implement download actions, connect to the QWebEngineProfile::downloadRequested signal. (Added in Qt 5.6) - \value DownloadImageToDisk + \value WebEngineView.DownloadImageToDisk Download the highlighted image to the disk. (Added in Qt 5.6) - \value DownloadMediaToDisk + \value WebEngineView.DownloadMediaToDisk Download the hovered audio or video to the disk. (Added in Qt 5.6) - \value InspectElement + \value WebEngineView.InspectElement Trigger any attached Web Inspector to inspect the highlighed element. (Added in Qt 5.6) - \value ExitFullScreen + \value WebEngineView.ExitFullScreen Exit the fullscreen mode. (Added in Qt 5.6) \omitvalue WebActionCount @@ -778,13 +780,13 @@ Describes the platform feature access categories that the user may be asked to grant or deny access to: - \value Geolocation + \value WebEngineView.Geolocation Location hardware or service. - \value MediaAudioCapture + \value WebEngineView.MediaAudioCapture Audio capture devices, such as microphones. - \value MediaVideoCapture + \value WebEngineView.MediaVideoCapture Video devices, such as cameras. - \value MediaAudioVideoCapture + \value WebEngineView.MediaAudioVideoCapture Both audio and video capture devices. \sa featurePermissionRequested(), grantFeaturePermission() -- cgit v1.2.3