diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2025-11-06 12:06:40 +0100 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2025-11-06 22:53:26 +0100 |
| commit | 2d4bb691635684759a8fbeeba374d67547b6bf30 (patch) | |
| tree | 8295adb57941681dd7af2119229e7694b0c7a370 | |
| parent | 9d112ae51e9360f28839d8a8d1cf7afd5d3accc9 (diff) | |
Doc: Add missing property docs
Task-number: QTBUG-140629
Change-Id: Iab2d22dba0ff8728786f3554bb537808735782cd
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| -rw-r--r-- | src/core/api/qwebenginecertificateerror.cpp | 9 | ||||
| -rw-r--r-- | src/core/api/qwebenginecontextmenurequest.cpp | 47 | ||||
| -rw-r--r-- | src/core/api/qwebenginedesktopmediarequest.cpp | 10 | ||||
| -rw-r--r-- | src/core/api/qwebenginedownloadrequest.cpp | 79 | ||||
| -rw-r--r-- | src/core/api/qwebengineextensioninfo.cpp | 5 | ||||
| -rw-r--r-- | src/core/api/qwebengineframe.cpp | 24 | ||||
| -rw-r--r-- | src/core/api/qwebenginehistory.cpp | 18 | ||||
| -rw-r--r-- | src/core/api/qwebengineloadinginfo.cpp | 2 | ||||
| -rw-r--r-- | src/core/api/qwebenginescript.cpp | 89 | ||||
| -rw-r--r-- | src/webenginequick/api/qquickwebenginedownloadrequest.cpp | 8 | ||||
| -rw-r--r-- | src/webenginequick/api/qquickwebengineprofile.cpp | 20 |
11 files changed, 181 insertions, 130 deletions
diff --git a/src/core/api/qwebenginecertificateerror.cpp b/src/core/api/qwebenginecertificateerror.cpp index 651252e22..1fb815832 100644 --- a/src/core/api/qwebenginecertificateerror.cpp +++ b/src/core/api/qwebenginecertificateerror.cpp @@ -85,7 +85,8 @@ bool QWebEngineCertificateError::isOverridable() const } /*! - Returns the URL that triggered the error. + \property QWebEngineCertificateError::url + \brief The URL that triggered the error. \sa description() */ @@ -112,7 +113,8 @@ bool QWebEngineCertificateError::isMainFrame() const } /*! - Returns the type of the error. + \property QWebEngineCertificateError::type + \brief The type of the error. \sa description(), isOverridable() */ @@ -124,7 +126,8 @@ QWebEngineCertificateError::Type QWebEngineCertificateError::type() const } /*! - Returns a short localized human-readable description of the error. + \property QWebEngineCertificateError::description + \brief A short localized human-readable description of the error. \sa url(), isOverridable() */ diff --git a/src/core/api/qwebenginecontextmenurequest.cpp b/src/core/api/qwebenginecontextmenurequest.cpp index 00c3c32f1..0a98f8e56 100644 --- a/src/core/api/qwebenginecontextmenurequest.cpp +++ b/src/core/api/qwebenginecontextmenurequest.cpp @@ -88,7 +88,8 @@ QWebEngineContextMenuRequest::QWebEngineContextMenuRequest( QWebEngineContextMenuRequest::~QWebEngineContextMenuRequest() = default; /*! - Returns the position of the context menu request, usually the mouse + \property QWebEngineContextMenuRequest::position + \brief The position of the context menu request, usually the mouse position where the context menu event was triggered. */ QPoint QWebEngineContextMenuRequest::position() const @@ -97,7 +98,8 @@ QPoint QWebEngineContextMenuRequest::position() const } /*! - Returns the selected text of the context menu request. + \property QWebEngineContextMenuRequest::selectedText + \brief The selected text of the context menu request. */ QString QWebEngineContextMenuRequest::selectedText() const { @@ -105,7 +107,8 @@ QString QWebEngineContextMenuRequest::selectedText() const } /*! - Returns the text of a link if the context menu request was requested for a link. + \property QWebEngineContextMenuRequest::linkText + \brief The text of a link if the context menu request was requested for a link. */ QString QWebEngineContextMenuRequest::linkText() const { @@ -113,7 +116,9 @@ QString QWebEngineContextMenuRequest::linkText() const } /*! - Returns the URL of a link if the menu context request is a link. + \property QWebEngineContextMenuRequest::linkUrl + \brief The URL of a link if the menu context request is a link. + It is not guaranteed to be a valid URL. */ QUrl QWebEngineContextMenuRequest::linkUrl() const @@ -122,7 +127,8 @@ QUrl QWebEngineContextMenuRequest::linkUrl() const } /*! - If the context menu request is a media element, returns the URL of that media. + \property QWebEngineContextMenuRequest::mediaUrl + \brief The URL of the media element if the context menu request is a media element. */ QUrl QWebEngineContextMenuRequest::mediaUrl() const { @@ -130,8 +136,9 @@ QUrl QWebEngineContextMenuRequest::mediaUrl() const } /*! - Returns the type of the media element or \c MediaTypeNone - if the context menu requestis not a media element. + \property QWebEngineContextMenuRequest::mediaType + \brief The type of the media element or \c MediaTypeNone + if the context menu request is not a media element. */ QWebEngineContextMenuRequest::MediaType QWebEngineContextMenuRequest::mediaType() const { @@ -139,8 +146,8 @@ QWebEngineContextMenuRequest::MediaType QWebEngineContextMenuRequest::mediaType( } /*! - Returns \c true if the context menu request is editable by the user; - otherwise returns \c false. + \property QWebEngineContextMenuRequest::isContentEditable + \brief Whether the context menu request is editable by the user. */ bool QWebEngineContextMenuRequest::isContentEditable() const { @@ -148,8 +155,9 @@ bool QWebEngineContextMenuRequest::isContentEditable() const } /*! - If the menu context request is a word considered misspelled by the spell-checker, - returns the misspelled word. + \property QWebEngineContextMenuRequest::misspelledWord + \brief The misspelled word if the menu context request is a word + considered misspelled by the spell-checker. For possible replacements of the word, see spellCheckerSuggestions(). */ @@ -160,8 +168,9 @@ QString QWebEngineContextMenuRequest::misspelledWord() const /*! - If the menu context request is a word considered misspelled by the spell-checker, - returns a list of suggested replacements for misspelledWord(). + \property QWebEngineContextMenuRequest::spellCheckerSuggestions + \brief A list of suggested replacements for misspelledWord() if the menu + context request is a word considered misspelled by the spell-checker. */ QStringList QWebEngineContextMenuRequest::spellCheckerSuggestions() const { @@ -183,8 +192,10 @@ void QWebEngineContextMenuRequest::setAccepted(bool accepted) } /*! - Returns the current media element's status and its available operations. - \c MediaNone if the selected web page content is not a media element. + \property QWebEngineContextMenuRequest::mediaFlags + \brief The current media element's status and its available operations. + + Returns \c MediaNone if the selected web page content is not a media element. */ QWebEngineContextMenuRequest::MediaFlags QWebEngineContextMenuRequest::mediaFlags() const { @@ -192,8 +203,10 @@ QWebEngineContextMenuRequest::MediaFlags QWebEngineContextMenuRequest::mediaFlag } /*! - Returns the available edit operations in the current context - or \c CanDoNone if no actions are available. + \property QWebEngineContextMenuRequest::editFlags + \brief The available edit operations in the current context. + + Returns \c CanDoNone if no actions are available. */ QWebEngineContextMenuRequest::EditFlags QWebEngineContextMenuRequest::editFlags() const { diff --git a/src/core/api/qwebenginedesktopmediarequest.cpp b/src/core/api/qwebenginedesktopmediarequest.cpp index 448ca4a8d..73e6abd39 100644 --- a/src/core/api/qwebenginedesktopmediarequest.cpp +++ b/src/core/api/qwebenginedesktopmediarequest.cpp @@ -158,9 +158,10 @@ QWebEngineDesktopMediaRequest::QWebEngineDesktopMediaRequest( QWebEngineDesktopMediaRequest &&other) noexcept = default; /*! - Returns a QAbstractListModel for the available screens. + \property QWebEngineDesktopMediaRequest::screensModel + \brief A QAbstractListModel for the available screens. - \sa windowsModel() + \sa windowsModel */ QAbstractListModel *QWebEngineDesktopMediaRequest::screensModel() const { @@ -168,9 +169,10 @@ QAbstractListModel *QWebEngineDesktopMediaRequest::screensModel() const } /*! - Returns a QAbstractListModel for the available windows. + \property QWebEngineDesktopMediaRequest::windowsModel + \brief A QAbstractListModel for the available windows. - \sa screensModel() + \sa screensModel */ QAbstractListModel *QWebEngineDesktopMediaRequest::windowsModel() const { diff --git a/src/core/api/qwebenginedownloadrequest.cpp b/src/core/api/qwebenginedownloadrequest.cpp index 2c90d4c94..084832f0d 100644 --- a/src/core/api/qwebenginedownloadrequest.cpp +++ b/src/core/api/qwebenginedownloadrequest.cpp @@ -295,7 +295,8 @@ void QWebEngineDownloadRequest::resume() } /*! - Returns the download item's ID. + \property QWebEngineDownloadRequest::id + \brief The download item's ID. */ quint32 QWebEngineDownloadRequest::id() const @@ -385,7 +386,8 @@ quint32 QWebEngineDownloadRequest::id() const */ /*! - Returns the download item's current state. + \property QWebEngineDownloadRequest::state + \brief The download item's current state. \sa DownloadState */ @@ -397,7 +399,8 @@ QWebEngineDownloadRequest::DownloadState QWebEngineDownloadRequest::state() cons } /*! - Returns the total amount of data to download in bytes. + \property QWebEngineDownloadRequest::totalBytes + \brief The total amount of data to download in bytes. \c -1 means the size is unknown. */ @@ -409,7 +412,8 @@ qint64 QWebEngineDownloadRequest::totalBytes() const } /*! - Returns the amount of data in bytes that has been downloaded so far. + \property QWebEngineDownloadRequest::receivedBytes + \brief The amount of data in bytes that has been downloaded so far. \c -1 means the size is unknown. */ @@ -421,7 +425,8 @@ qint64 QWebEngineDownloadRequest::receivedBytes() const } /*! - Returns the download's origin URL. + \property QWebEngineDownloadRequest::url + \brief The download's origin URL. */ QUrl QWebEngineDownloadRequest::url() const @@ -431,7 +436,8 @@ QUrl QWebEngineDownloadRequest::url() const } /*! - Returns the MIME type of the download. + \property QWebEngineDownloadRequest::mimeType + \brief The MIME type of the download. */ QString QWebEngineDownloadRequest::mimeType() const @@ -441,7 +447,13 @@ QString QWebEngineDownloadRequest::mimeType() const } /*! - Returns the download directory path. + \property QWebEngineDownloadRequest::downloadDirectory + \brief The download directory path. + + The download directory path can only be set in response to the + QWebEngineProfile::downloadRequested() signal before the download is + accepted. Past that point, this property has no effect on the download + item's state. */ QString QWebEngineDownloadRequest::downloadDirectory() const @@ -450,14 +462,6 @@ QString QWebEngineDownloadRequest::downloadDirectory() const return d->downloadDirectory; } -/*! - Sets \a directory as the directory path to download the file to. - - The download directory path can only be set in response to the QWebEngineProfile::downloadRequested() - signal before the download is accepted. Past that point, this function has no effect on the - download item's state. -*/ - void QWebEngineDownloadRequest::setDownloadDirectory(const QString &directory) { Q_D(QWebEngineDownloadRequest); @@ -483,7 +487,13 @@ void QWebEngineDownloadRequest::setDownloadDirectory(const QString &directory) } /*! - Returns the file name to download the file to. + \property QWebEngineDownloadRequest::downloadFileName + \brief The file name to download the file to. + + The download file name can only be set in response to the + QWebEngineProfile::downloadRequested() signal before the download is + accepted. Past that point, this property has no effect on the download + item's state. */ QString QWebEngineDownloadRequest::downloadFileName() const @@ -492,14 +502,6 @@ QString QWebEngineDownloadRequest::downloadFileName() const return d->downloadFileName; } -/*! - Sets \a fileName as the file name to download the file to. - - The download file name can only be set in response to the QWebEngineProfile::downloadRequested() - signal before the download is accepted. Past that point, this function has no effect on the - download item's state. -*/ - void QWebEngineDownloadRequest::setDownloadFileName(const QString &fileName) { Q_D(QWebEngineDownloadRequest); @@ -516,7 +518,8 @@ void QWebEngineDownloadRequest::setDownloadFileName(const QString &fileName) } /*! - Returns the suggested file name. + \property QWebEngineDownloadRequest::suggestedFileName + \brief The suggested file name. */ QString QWebEngineDownloadRequest::suggestedFileName() const @@ -553,8 +556,10 @@ bool QWebEngineDownloadRequest::isPaused() const } /*! - Returns the format the web page will be saved in if this is a download request for a web page. - \sa setSavePageFormat(), isSavePageDownload() + \property QWebEngineDownloadRequest::savePageFormat + \brief The format the web page will be saved in if this is a download request for a web page. + + \sa isSavePageDownload */ QWebEngineDownloadRequest::SavePageFormat QWebEngineDownloadRequest::savePageFormat() const { @@ -562,11 +567,6 @@ QWebEngineDownloadRequest::SavePageFormat QWebEngineDownloadRequest::savePageFor return d->savePageFormat; } -/*! - Sets the \a format the web page will be saved in if this is a download request for a web page. - - \sa savePageFormat(), isSavePageDownload() -*/ void QWebEngineDownloadRequest::setSavePageFormat(QWebEngineDownloadRequest::SavePageFormat format) { Q_D(QWebEngineDownloadRequest); @@ -577,9 +577,10 @@ void QWebEngineDownloadRequest::setSavePageFormat(QWebEngineDownloadRequest::Sav } /*! - Returns \c true if this is a download request for saving a web page. + \property QWebEngineDownloadRequest::isSavePageDownload + \brief Whether this is a download request for saving a web page. - \sa savePageFormat(), setSavePageFormat() + \sa savePageFormat */ bool QWebEngineDownloadRequest::isSavePageDownload() const { @@ -588,9 +589,10 @@ bool QWebEngineDownloadRequest::isSavePageDownload() const } /*! - Returns the reason why the download was interrupted. + \property QWebEngineDownloadRequest::interruptReason + \brief The reason why the download was interrupted. - \sa interruptReasonString() + \sa interruptReasonString */ QWebEngineDownloadRequest::DownloadInterruptReason QWebEngineDownloadRequest::interruptReason() const @@ -600,9 +602,10 @@ QWebEngineDownloadRequest::DownloadInterruptReason QWebEngineDownloadRequest::in } /*! - Returns a human-readable description of the reason for interrupting the download. + \property QWebEngineDownloadRequest::interruptReasonString + \brief A human-readable description of the reason for interrupting the download. - \sa interruptReason() + \sa interruptReason */ QString QWebEngineDownloadRequest::interruptReasonString() const diff --git a/src/core/api/qwebengineextensioninfo.cpp b/src/core/api/qwebengineextensioninfo.cpp index 72e4a9abe..9ac4ca74f 100644 --- a/src/core/api/qwebengineextensioninfo.cpp +++ b/src/core/api/qwebengineextensioninfo.cpp @@ -212,10 +212,9 @@ bool QWebEngineExtensionInfo::isLoaded() const return d_ptr && d_ptr->isLoaded(); } -/* +/*! \property QWebEngineExtensionInfo::isInstalled - \brief This property holds whether the extension is installed in the profile's install - directory. + \brief whether the extension is installed in the profile's install directory. \sa QWebEngineExtensionManager::installDirectory(), QWebEngineExtensionManager::installExtension(), QWebEngineExtensionManager::uninstallExtension() diff --git a/src/core/api/qwebengineframe.cpp b/src/core/api/qwebengineframe.cpp index 6bced5b06..4fec8233e 100644 --- a/src/core/api/qwebengineframe.cpp +++ b/src/core/api/qwebengineframe.cpp @@ -47,7 +47,8 @@ QWebEngineFrame::QWebEngineFrame(QWeakPointer<QtWebEngineCore::WebContentsAdapte } /*! - Returns \c{true} if this object represents an existing frame; \c{false} otherwise. + \property QWebEngineFrame::isValid + \brief Whether this object represents an existing frame. Once a frame is invalid, it never becomes valid again. */ @@ -58,7 +59,8 @@ bool QWebEngineFrame::isValid() const } /*! - Returns the frame name; that is, what would be returned by \c window.name in JavaScript. + \property QWebEngineFrame::name + \brief The frame name; that is, what would be returned by \c window.name in JavaScript. If the frame could not be found, returns a null QString. @@ -71,7 +73,8 @@ QString QWebEngineFrame::name() const } /*! - Returns the value of the frame's \c name HTML attribute, or an empty string if it has none. + \property QWebEngineFrame::htmlName + \brief The value of the frame's \c name HTML attribute, or an empty string if it has none. If the frame could not be found, returns a null QString. @@ -84,7 +87,8 @@ QString QWebEngineFrame::htmlName() const } /*! - Returns a list of the frame's children in an arbitrary order. + \property QWebEngineFrame::children + \brief A list of the frame's children in an arbitrary order. If the frame could not be found, returns an empty list. */ @@ -98,7 +102,8 @@ QList<QWebEngineFrame> QWebEngineFrame::children() const } /*! - Returns the URL of the content currently loaded in this frame. + \property QWebEngineFrame::url + \brief The URL of the content currently loaded in this frame. If the frame could not be found, returns an empty QUrl. */ @@ -109,8 +114,10 @@ QUrl QWebEngineFrame::url() const } /*! - Returns the size of the frame within the viewport, measured in logical pixels. On devices - with a scale factor other than 100%, this will not correspond to the on-screen size; + \property QWebEngineFrame::size + \brief The size of the frame within the viewport, measured in logical pixels. + + On devices with a scale factor other than 100%, this will not correspond to the on-screen size; instead, it will be the size before scaling is applied. In such cases, the size may contain fractional values. @@ -123,7 +130,8 @@ QSizeF QWebEngineFrame::size() const } /*! - Returns \c{true} if this object represents the page's main frame; \c{false} otherwise. + \property QWebEngineFrame::isMainFrame + \brief Whether this object represents the page's main frame. */ bool QWebEngineFrame::isMainFrame() const { diff --git a/src/core/api/qwebenginehistory.cpp b/src/core/api/qwebenginehistory.cpp index a6b44ce61..24c5005b5 100644 --- a/src/core/api/qwebenginehistory.cpp +++ b/src/core/api/qwebenginehistory.cpp @@ -350,6 +350,12 @@ int QWebEngineHistory::count() const return d->adapter()->navigationEntryCount(); } +/*! + \property QWebEngineHistory::items + \brief A model containing all history items. + + \sa backItems, forwardItems +*/ QWebEngineHistoryModel *QWebEngineHistory::itemsModel() const { Q_D(const QWebEngineHistory); @@ -358,6 +364,12 @@ QWebEngineHistoryModel *QWebEngineHistory::itemsModel() const return d->navigationModel.data(); } +/*! + \property QWebEngineHistory::backItems + \brief A model containing the back history items. + + \sa items, forwardItems +*/ QWebEngineHistoryModel *QWebEngineHistory::backItemsModel() const { Q_D(const QWebEngineHistory); @@ -366,6 +378,12 @@ QWebEngineHistoryModel *QWebEngineHistory::backItemsModel() const return d->backNavigationModel.data(); } +/*! + \property QWebEngineHistory::forwardItems + \brief A model containing the forward history items. + + \sa items, backItems +*/ QWebEngineHistoryModel *QWebEngineHistory::forwardItemsModel() const { Q_D(const QWebEngineHistory); diff --git a/src/core/api/qwebengineloadinginfo.cpp b/src/core/api/qwebengineloadinginfo.cpp index 60e502616..12e6762f0 100644 --- a/src/core/api/qwebengineloadinginfo.cpp +++ b/src/core/api/qwebengineloadinginfo.cpp @@ -151,7 +151,7 @@ QString QWebEngineLoadingInfo::errorString() const \value HttpStatusCodeDomain Error is the HTTP response status code, even in case of success e.g. the server replied with status 200. */ -/* +/*! \property QWebEngineLoadingInfo::errorDomain \brief Holds the error domain. */ diff --git a/src/core/api/qwebenginescript.cpp b/src/core/api/qwebenginescript.cpp index 919556fd9..4548c803d 100644 --- a/src/core/api/qwebenginescript.cpp +++ b/src/core/api/qwebenginescript.cpp @@ -112,20 +112,20 @@ QWebEngineScript &QWebEngineScript::operator=(const QWebEngineScript &other) } /*! - * Returns the name of the script. Can be useful to retrieve a particular script from a - * QWebEngineScriptCollection. - * - * \sa QWebEngineScriptCollection::find() - */ + \property QWebEngineScript::name + \brief The name of the script. + + Can be useful to retrieve a particular script from a + QWebEngineScriptCollection. + + \sa QWebEngineScriptCollection::find() +*/ QString QWebEngineScript::name() const { return d->name(); } -/*! - * Sets the script name to \a scriptName. - */ void QWebEngineScript::setName(const QString &scriptName) { if (scriptName == name()) @@ -134,25 +134,23 @@ void QWebEngineScript::setName(const QString &scriptName) } /*! - * Returns the remote source location of the user script (if any). - */ + \property QWebEngineScript::sourceUrl + \brief The remote source location of the user script (if any). + + Unlike setSourceCode(), setting this property allows referring to user scripts that + are not already loaded in memory, for instance, when stored on disk. + + Setting this value will change the \l sourceCode of the script. + + \note At present, only file-based sources are supported. + + \sa sourceCode +*/ QUrl QWebEngineScript::sourceUrl() const { return d->sourceUrl(); } -/*! - * Sets the remote source location of the user script to \a url. - * - * Unlike \l setSourceCode(), this function allows referring to user scripts that - * are not already loaded in memory, for instance, when stored on disk. - * - * Setting this value will change the \l sourceCode of the script. - * - * \note At present, only file-based sources are supported. - * - * \sa setSourceCode() - */ void QWebEngineScript::setSourceUrl(const QUrl &url) { if (url == sourceUrl()) @@ -178,16 +176,14 @@ void QWebEngineScript::setSourceUrl(const QUrl &url) } /*! - Returns the source of the script. - */ + \property QWebEngineScript::sourceCode + \brief The source of the script. +*/ QString QWebEngineScript::sourceCode() const { return d->sourceCode(); } -/*! - * Sets the script source to \a scriptSource. - */ void QWebEngineScript::setSourceCode(const QString &scriptSource) { if (scriptSource == sourceCode()) @@ -200,20 +196,18 @@ ASSERT_ENUMS_MATCH(QWebEngineScript::DocumentReady, UserScript::DocumentLoadFini ASSERT_ENUMS_MATCH(QWebEngineScript::DocumentCreation, UserScript::DocumentElementCreation) /*! - * Returns the point in the loading process at which the script will be executed. - * The default value is QWebEngineScript::Deferred. - * - * \sa setInjectionPoint() - */ + \property QWebEngineScript::injectionPoint + \brief The point in the loading process at which the script will be executed. + + The default value is QWebEngineScript::Deferred. + + \sa InjectionPoint +*/ QWebEngineScript::InjectionPoint QWebEngineScript::injectionPoint() const { return static_cast<QWebEngineScript::InjectionPoint>(d->injectionPoint()); } -/*! - * Sets the point at which to execute the script to be \a p. - * - * \sa InjectionPoint - */ + void QWebEngineScript::setInjectionPoint(QWebEngineScript::InjectionPoint p) { if (p == injectionPoint()) @@ -222,18 +216,16 @@ void QWebEngineScript::setInjectionPoint(QWebEngineScript::InjectionPoint p) } /*! - Returns the world ID defining which world the script is executed in. - */ + \property QWebEngineScript::worldId + \brief The world ID defining which world the script is executed in. + + Must be between \c 0 and \c 256. +*/ quint32 QWebEngineScript::worldId() const { return d->worldId(); } -/*! - Sets the world ID of the isolated world to \a id when running this script. - - Must be between \c 0 and \c 256. - */ void QWebEngineScript::setWorldId(quint32 id) { if (id == d->worldId()) @@ -242,17 +234,14 @@ void QWebEngineScript::setWorldId(quint32 id) } /*! - Returns \c true if the script is executed on every frame in the page, or \c false if it is only - ran for the main frame. - */ + \property QWebEngineScript::runsOnSubFrames + \brief Whether the script is executed on every frame in the page, or only on the main frame. +*/ bool QWebEngineScript::runsOnSubFrames() const { return d->runsOnSubFrames(); } -/*! - * Executes the script on sub frames in addition to the main frame if \a on returns \c true. - */ void QWebEngineScript::setRunsOnSubFrames(bool on) { if (runsOnSubFrames() == on) diff --git a/src/webenginequick/api/qquickwebenginedownloadrequest.cpp b/src/webenginequick/api/qquickwebenginedownloadrequest.cpp index f2b10e972..2816a2ac1 100644 --- a/src/webenginequick/api/qquickwebenginedownloadrequest.cpp +++ b/src/webenginequick/api/qquickwebenginedownloadrequest.cpp @@ -19,9 +19,11 @@ QQuickWebEngineDownloadRequest::QQuickWebEngineDownloadRequest(QWebEngineDownloa } /*! - \internal - Returns the WebEngineView the download was requested on. If the download was not triggered by content in a WebEngineView, - \c nullptr is returned. + \property QQuickWebEngineDownloadRequest::view + \brief The WebEngineView the download was requested on. + + If the download was not triggered by content in a WebEngineView, + returns \nullptr. */ QQuickWebEngineView *QQuickWebEngineDownloadRequest::view() const { diff --git a/src/webenginequick/api/qquickwebengineprofile.cpp b/src/webenginequick/api/qquickwebengineprofile.cpp index 0436407f9..7ed2d4a0a 100644 --- a/src/webenginequick/api/qquickwebengineprofile.cpp +++ b/src/webenginequick/api/qquickwebengineprofile.cpp @@ -1136,10 +1136,16 @@ QQuickWebEngineSettings *QQuickWebEngineProfile::settings() const } /*! + \property QQuickWebEngineProfile::userScripts + + \brief The collection of WebEngineScript objects that are injected into + all pages that share this profile. +*/ +/*! + \property QQuickWebEngineProfile::userScripts \qmlproperty WebEngineScriptCollection WebEngineProfile::userScripts \since 1.5 - - Returns the collection of WebEngineScript objects that are injected into + \brief The collection of WebEngineScript objects that are injected into all pages that share this profile. */ @@ -1164,7 +1170,8 @@ QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore } /*! - Return the Client Hints settings associated with this browsing context. + \property QQuickWebEngineProfile::clientHints + \brief The Client Hints settings associated with this browsing context. \since 6.8 \sa QWebEngineClientHints @@ -1175,6 +1182,13 @@ QWebEngineClientHints *QQuickWebEngineProfile::clientHints() const return d->m_clientHints.data(); } +/*! + \property QQuickWebEngineProfile::extensionManager + \brief The extension manager associated with this profile. + + \since 6.10 + \sa QWebEngineExtensionManager +*/ QWebEngineExtensionManager *QQuickWebEngineProfile::extensionManager() { #if QT_CONFIG(webengine_extensions) |