summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorKaloyan Chehlarski <kaloyan.chehlarski@qt.io>2025-01-21 14:25:30 +0100
committerKaloyan Chehlarski <kaloyan.chehlarski@qt.io>2025-02-10 16:36:50 +0100
commit49029332a6a3cf92e255f95d425451b054d4e583 (patch)
treebefcff750db2d24a93ac16be0a96b3d3212a4a94 /src
parent4d48b5bdee980387f3d335080f842f4f013ff33e (diff)
Doc: Various punctuation fixes
Change-Id: I65b22658eb46e2460e0bd8d82f528671b33fad66 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/core/api/qwebenginepage.cpp4
-rw-r--r--src/core/api/qwebengineprofile.cpp2
-rw-r--r--src/core/api/qwebenginescript.cpp2
-rw-r--r--src/core/api/qwebengineurlrequestinfo.cpp6
-rw-r--r--src/core/api/qwebengineurlrequestjob.cpp6
-rw-r--r--src/core/api/qwebengineurlschemehandler.cpp4
-rw-r--r--src/core/api/qwebenginewebauthuxrequest.cpp12
-rw-r--r--src/core/doc/src/qwebenginepage_lgpl.qdoc14
-rw-r--r--src/webenginequick/doc/src/context_menu_request.qdoc8
-rw-r--r--src/webenginequick/doc/src/webengine_download_request.qdoc2
-rw-r--r--src/webenginequick/doc/src/webengineview_lgpl.qdoc15
-rw-r--r--src/webenginewidgets/api/qwebengineview.cpp2
-rw-r--r--src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc2
13 files changed, 39 insertions, 40 deletions
diff --git a/src/core/api/qwebenginepage.cpp b/src/core/api/qwebenginepage.cpp
index 3f9c2102c..aa587cca6 100644
--- a/src/core/api/qwebenginepage.cpp
+++ b/src/core/api/qwebenginepage.cpp
@@ -2502,7 +2502,7 @@ void QWebEnginePage::setLifecycleState(LifecycleState state)
Setting the lifecycle state to a lower resource usage state than the
recommended state may cause side-effects such as stopping background audio
playback or loss of HTML form input. Setting the lifecycle state to a higher
- resource state is however completely safe.
+ resource state is, however, completely safe.
\sa lifecycleState, {Page Lifecycle API}, {WebEngine Lifecycle Example}
*/
@@ -2524,7 +2524,7 @@ QWebEnginePage::LifecycleState QWebEnginePage::recommendedState() const
to voluntarily reduce their resource usage if they are not visible to the
user.
- If the page is connected to a \e {view} then this property will be managed
+ If the page is connected to a \e {view}, then this property will be managed
automatically by the view according to its own visibility.
\sa lifecycleState
diff --git a/src/core/api/qwebengineprofile.cpp b/src/core/api/qwebengineprofile.cpp
index 1c5807a93..47c04605b 100644
--- a/src/core/api/qwebengineprofile.cpp
+++ b/src/core/api/qwebengineprofile.cpp
@@ -435,7 +435,7 @@ void QWebEngineProfile::setDownloadPath(const QString &path)
\since 6.5
Returns \c true if the push messaging service is enabled.
- \note By default the push messaging service is disabled.
+ \note By default, the push messaging service is disabled.
\sa setPushServiceEnabled()
*/
diff --git a/src/core/api/qwebenginescript.cpp b/src/core/api/qwebenginescript.cpp
index 8d1ff46bf..ee9d59a6b 100644
--- a/src/core/api/qwebenginescript.cpp
+++ b/src/core/api/qwebenginescript.cpp
@@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE
\value 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 The default isolated world used for application level functionality implemented in JavaScript.
+ \value ApplicationWorld The default isolated world used for application-level functionality implemented in JavaScript.
\value 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/core/api/qwebengineurlrequestinfo.cpp b/src/core/api/qwebengineurlrequestinfo.cpp
index 3bb4ac806..85362c500 100644
--- a/src/core/api/qwebengineurlrequestinfo.cpp
+++ b/src/core/api/qwebengineurlrequestinfo.cpp
@@ -32,9 +32,9 @@ ASSERT_ENUMS_MATCH(QtWebEngineCore::WebContentsAdapterClient::RedirectNavigation
\since 5.6
\brief The QWebEngineUrlRequestInfo class provides information about URL requests.
- The QWebEngineUrlRequestInfo is useful for setting extra header fields for requests
+ The QWebEngineUrlRequestInfo is useful for setting extra header fields for requests,
or for redirecting certain requests without payload data to another URL.
- This class cannot be instantiated or copied by the user, instead it will
+ This class cannot be instantiated or copied by the user; instead, it will
be created by \QWE and sent through the virtual function
QWebEngineUrlRequestInterceptor::interceptRequest() if an interceptor has been set.
*/
@@ -247,7 +247,7 @@ QByteArray QWebEngineUrlRequestInfo::requestMethod() const
/*!
Returns a pointer to a QIODevice that gives access to the request body.
The request body can contain data for example when the request is
- a POST request. If the request body is empty the QIODevice reflects this
+ a POST request. If the request body is empty, the QIODevice reflects this
and does not return any data when performing read operations on it.
\since 6.7
diff --git a/src/core/api/qwebengineurlrequestjob.cpp b/src/core/api/qwebengineurlrequestjob.cpp
index b969b2369..6ef94e41d 100644
--- a/src/core/api/qwebengineurlrequestjob.cpp
+++ b/src/core/api/qwebengineurlrequestjob.cpp
@@ -113,8 +113,8 @@ QMap<QByteArray, QByteArray> QWebEngineUrlRequestJob::requestHeaders() const
/*!
Returns a pointer to a QIODevice that gives access to the request body.
- The request body can contain data for example when the request is
- a POST request. If the request body is empty the QIODevice reflects this
+ The request body can contain data, for example, when the request is
+ a POST request. If the request body is empty, the QIODevice reflects this
and does not return any data when performing read operations on it.
\since 6.7
@@ -146,7 +146,7 @@ void QWebEngineUrlRequestJob::setAdditionalResponseHeaders(
The user has to be aware that \a device will be used on another thread
until the job is deleted. In case simultaneous access from the main thread
is desired, the user is reponsible for making access to \a device thread-safe
- for example by using QMutex. Note that the \a device object is not owned by
+ (for example, by using QMutex). Note that the \a device object is not owned by
the web engine. Therefore, the signal QObject::destroyed() of
QWebEngineUrlRequestJob must be monitored.
diff --git a/src/core/api/qwebengineurlschemehandler.cpp b/src/core/api/qwebengineurlschemehandler.cpp
index cc77bcac8..7aeaec850 100644
--- a/src/core/api/qwebengineurlschemehandler.cpp
+++ b/src/core/api/qwebengineurlschemehandler.cpp
@@ -27,12 +27,12 @@ QT_BEGIN_NAMESPACE
over a custom scheme may be given access to local resources, be set to
ignore Content-Security-Policy rules, or conversely, be denied access to any
other content entirely. If it is to be accessed by normal content, ensure cross-origin
- access is enabled, and if accessed from HTTPS that it is marked as secure.
+ access is enabled, and if accessed from HTTPS, that it is marked as secure.
\note Make sure that you create and register the scheme object \e before the QGuiApplication
or QApplication object is instantiated.
- Then you must create a class derived from QWebEngineUrlSchemeHandler,
+ Then, you must create a class derived from QWebEngineUrlSchemeHandler,
and reimplement the requestStarted() method.
Finally, install the scheme handler object via QWebEngineProfile::installUrlSchemeHandler()
diff --git a/src/core/api/qwebenginewebauthuxrequest.cpp b/src/core/api/qwebenginewebauthuxrequest.cpp
index e05aef9e8..4df675795 100644
--- a/src/core/api/qwebenginewebauthuxrequest.cpp
+++ b/src/core/api/qwebenginewebauthuxrequest.cpp
@@ -266,7 +266,7 @@ QWebEngineWebAuthUxRequest::~QWebEngineWebAuthUxRequest() { }
WebAuth dialog displays user names. The user needs to select an
account to proceed.
- \sa state setSelectedAccount() QWebEngineWebAuthUxRequest::userNames
+ \sa state, setSelectedAccount(), QWebEngineWebAuthUxRequest::userNames
*/
/*!
\property QWebEngineWebAuthUxRequest::userNames
@@ -312,7 +312,7 @@ QString QWebEngineWebAuthUxRequest::relyingPartyId() const
WebAuth Dialog displays a PIN request dialog. The user needs to enter a PIN and
invoke \l setPin() to proceed.
- \sa QWebEngineWebAuthPinRequest CollectPin setPin()
+ \sa QWebEngineWebAuthPinRequest, CollectPin, setPin()
*/
QWebEngineWebAuthPinRequest QWebEngineWebAuthUxRequest::pinRequest() const
{
@@ -360,14 +360,14 @@ QWebEngineWebAuthUxRequest::WebAuthUxState QWebEngineWebAuthUxRequest::state() c
WebAuth request is blocked until the user selects an account and
invokes this method.
- \sa WebEngineWebAuthUxRequest::userNames state
+ \sa WebEngineWebAuthUxRequest::userNames, state
*/
/*!
Sends the \a selectedAccount name to the authenticator.
This is needed when the current WebAuth request's UX state is \l SelectAccount.
The WebAuth request is blocked until the user selects an account and invokes this method.
- \sa userNames SelectAccount
+ \sa userNames, SelectAccount
*/
void QWebEngineWebAuthUxRequest::setSelectedAccount(const QString &selectedAccount)
{
@@ -383,14 +383,14 @@ void QWebEngineWebAuthUxRequest::setSelectedAccount(const QString &selectedAccou
WebEngineWebAuthUxRequest.WebAuthUxState.CollectPin. The WebAuth
request is blocked until the user responds with a PIN.
- \sa QWebEngineWebAuthPinRequest state
+ \sa QWebEngineWebAuthPinRequest, state
*/
/*!
Sends the \a pin to the authenticator that prompts for a PIN.
This is needed when the current WebAuth request's UX state is \l CollectPin.
The WebAuth request is blocked until the user responds with a PIN.
- \sa QWebEngineWebAuthPinRequest CollectPin
+ \sa QWebEngineWebAuthPinRequest, CollectPin
*/
void QWebEngineWebAuthUxRequest::setPin(const QString &pin)
{
diff --git a/src/core/doc/src/qwebenginepage_lgpl.qdoc b/src/core/doc/src/qwebenginepage_lgpl.qdoc
index e464a2472..ef3ea5d72 100644
--- a/src/core/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/core/doc/src/qwebenginepage_lgpl.qdoc
@@ -152,16 +152,16 @@
\l createWindow() or \l newWindowRequested().
\value [since 5.10] ToggleBold
- Toggles boldness for the selection or at the cursor position.
+ Toggles boldness for the selection, or at the cursor position.
Requires \c contenteditable="true".
\value [since 5.10] ToggleItalic
- Toggles italics for the selection or at the cursor position.
+ Toggles italics for the selection, or at the cursor position.
Requires \c contenteditable="true".
\value [since 5.10] ToggleUnderline
- Toggles underlining of the selection or at the cursor position.
+ Toggles underlining of the selection, or at the cursor position.
Requires \c contenteditable="true".
\value [since 5.10] ToggleStrikethrough
- Toggles striking through the selection or at the cursor position.
+ Toggles striking through the selection, or at the cursor position.
Requires \c contenteditable="true".
\value [since 5.10] AlignLeft
@@ -590,7 +590,7 @@
\fn void QWebEnginePage::geometryChangeRequested(const QRect& geom)
This signal is emitted whenever the document wants to change the position and size of the
- page to \a geom. This can happen for example through JavaScript.
+ page to \a geom. This can happen, for example, through JavaScript.
\note \l{QWindow::}{setGeometry()} expects a size excluding the window
decoration, while \a geom includes it. You have to remove the size of the frame margins
@@ -644,7 +644,7 @@
\brief The title of the page as defined by the HTML \c <title> element.
If the page has no \c <title> element, then the URL is used instead. For \c
- file:// URLs only the filename is used and not the full path.
+ file:// URLs only the filename is used, and not the full path.
By default, before any content has been loaded, this property contains an
empty string.
@@ -757,7 +757,7 @@
\c MainWorld.
When the script has been executed, \a resultCallback is called with the result of the last
- executed statement. \c resultCallback can be any of a function pointer, a functor or a lambda,
+ executed statement. \c resultCallback can be any of a function pointer, a functor, or a lambda,
and it is expected to take a QVariant parameter. For example:
\code
diff --git a/src/webenginequick/doc/src/context_menu_request.qdoc b/src/webenginequick/doc/src/context_menu_request.qdoc
index e253ffb05..fdd7c10d4 100644
--- a/src/webenginequick/doc/src/context_menu_request.qdoc
+++ b/src/webenginequick/doc/src/context_menu_request.qdoc
@@ -55,14 +55,14 @@
\qmlproperty string ContextMenuRequest::linkText
\readonly
- The text of the link if the context menu was requested for a link.
+ The text of the link, if the context menu was requested for a link.
*/
/*!
\qmlproperty url ContextMenuRequest::linkUrl
\readonly
- The URL of the link if the selected web page content is a link.
+ The URL of the link, if the selected web page content is a link.
It is not guaranteed to be a valid URL.
*/
@@ -70,14 +70,14 @@
\qmlproperty url ContextMenuRequest::mediaUrl
\readonly
- The URL of media if the selected web content is a media element.
+ The URL of media, if the selected web content is a media element.
*/
/*!
\qmlproperty enumeration ContextMenuRequest::mediaType
\readonly
- The type of the media element or \c MediaTypeNone if
+ The type of the media element, or \c MediaTypeNone if
the selected web page content is not a media element.
\value ContextMenuRequest.MediaTypeNone
diff --git a/src/webenginequick/doc/src/webengine_download_request.qdoc b/src/webenginequick/doc/src/webengine_download_request.qdoc
index bc93edb62..fa50ebcf5 100644
--- a/src/webenginequick/doc/src/webengine_download_request.qdoc
+++ b/src/webenginequick/doc/src/webengine_download_request.qdoc
@@ -150,7 +150,7 @@
/*!
\qmlproperty string WebEngineDownloadRequest::downloadDirectory
- Holds the full target path without file name where data is being downloaded to.
+ Holds the full target path (without file name) where data is being downloaded to.
The download directory can only be set in the
\l{WebEngineProfile::downloadRequested}{downloadRequested} handler before
diff --git a/src/webenginequick/doc/src/webengineview_lgpl.qdoc b/src/webenginequick/doc/src/webengineview_lgpl.qdoc
index 3f042a8c3..e22c6df05 100644
--- a/src/webenginequick/doc/src/webengineview_lgpl.qdoc
+++ b/src/webenginequick/doc/src/webengineview_lgpl.qdoc
@@ -30,9 +30,8 @@
\section2 Loading Web Pages
- An application can load pages into the WebEngineView, using either the \l url property or the
- \l loadHtml method and navigate within the view's session history. The GET
- method is always used to load URLs.
+ An application can load pages into the WebEngineView using either the \l url property, or the
+ \l loadHtml method. The GET method is always used to load URLs.
The history is represented by a WebEngineHistory data model that is held by
the \l history property.
@@ -70,7 +69,7 @@
The \l {WebEngineSettings::focusOnNavigationEnabled} {focusOnNavigationEnabled} setting can be
used to make the view automatically receive focus when a navigation operation occurs
- (like loading or reloading a page or navigating through history).
+ (like loading or reloading a page, or navigating through history).
The \l linkHovered() signal is emitted when a mouse pointer passes over a link and thus
corresponds to the \c{mouseover} DOM event.
@@ -110,7 +109,7 @@
\section2 Platform Features
- Web pages can request access to platform features, such as geolocation or audio and video
+ Web pages can request access to platform features such as geolocation, or audio and video
capture devices. The \l permissionRequested() signal is emitted when a web page requests
to make use of a resource. The supported platform features are described by the QWebEnginePermission::Feature
property.
@@ -1098,7 +1097,7 @@
\a recentlyAudible, is changed, due to audio being played or stopped.
\note The signal is also emitted when the \l audioMuted property changes.
- Also if the audio is paused, this signal is emitted with an approximate \b{two-second
+ Also, if the audio is paused this signal is emitted with an approximate \b{two-second
delay}, from the moment the audio is paused.
If a web page contains two videos that are started in sequence, this signal
@@ -1173,7 +1172,7 @@
\since QtWebEngine 1.3
This signal is emitted when the page's audible state, specified by
- \a wasRecentlyAudible, is changed, due to audio being played or stopped.
+ \a wasRecentlyAudible, is changed due to audio being played or stopped.
\note The signal is also emitted when calling the setAudioMuted method.
*/
@@ -1453,7 +1452,7 @@
Setting the lifecycle state to a lower resource usage state than the
recommended state may cause side-effects such as stopping background audio
playback or loss of HTML form input. Setting the lifecycle state to a higher
- resource state is however completely safe.
+ resource state is, however, completely safe.
\sa lifecycleState, {Page Lifecycle API}, {WebEngine Lifecycle Example}
*/
diff --git a/src/webenginewidgets/api/qwebengineview.cpp b/src/webenginewidgets/api/qwebengineview.cpp
index 132e16c9a..f8b514d32 100644
--- a/src/webenginewidgets/api/qwebengineview.cpp
+++ b/src/webenginewidgets/api/qwebengineview.cpp
@@ -1489,7 +1489,7 @@ void QWebEngineView::printToPdf(const std::function<void(const QByteArray&)> &re
the \l QWebEnginePage::Stop web action.
\note This function rasterizes the result when rendering onto \a printer. Please consider raising
- the default resolution of \a printer to at least 300 DPI or using printToPdf() to produce
+ the default resolution of \a printer to at least 300 DPI, or using printToPdf() to produce
PDF file output more effectively.
\since 6.2
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 3153ec952..016411aee 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -370,7 +370,7 @@
/*!
\fn QWebEngineSettings *QWebEngineView::settings() const
- Returns a pointer to the view or page specific settings object.
+ Returns a pointer to the view- or page-specific settings object.
It is equivalent to:
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-18 04:14:24 +0000