From 598bfc652edffb047948e01c3c76eb9e0cb7db4e Mon Sep 17 00:00:00 2001
From: Kai Koehne <kai.koehne@qt.io>
Date: Thu, 21 Feb 2019 17:01:03 +0100
Subject: Doc: Always treat \brief as full sentence

Make sure all \brief descriptions start with an upper-case letter and end with a .

Also start descriptions of \class with the name of the class or struct.

Change-Id: Ifd2656201f9c1dff092085508a5423ce516e2d3f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
---
 src/core/api/qwebenginecookiestore.cpp                     |  2 +-
 src/core/api/qwebengineurlschemehandler.cpp                |  2 +-
 src/webengine/api/qquickwebengineprofile.cpp               |  2 +-
 src/webengine/api/qquickwebengineview.cpp                  |  2 +-
 src/webengine/doc/src/qtwebengine-examples.qdoc            |  2 +-
 src/webengine/doc/src/qtwebengine-qmlmodule.qdoc           |  2 +-
 src/webenginewidgets/api/qwebenginepage.cpp                | 12 ++++++------
 src/webenginewidgets/api/qwebengineview.cpp                |  2 +-
 .../doc/src/qtwebenginewidgets-examples.qdoc               |  2 +-
 src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc      | 14 +++++++-------
 src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc      | 12 ++++++------
 11 files changed, 27 insertions(+), 27 deletions(-)

(limited to 'src')

diff --git a/src/core/api/qwebenginecookiestore.cpp b/src/core/api/qwebenginecookiestore.cpp
index 035c98342..3897fb128 100644
--- a/src/core/api/qwebenginecookiestore.cpp
+++ b/src/core/api/qwebenginecookiestore.cpp
@@ -382,7 +382,7 @@ void QWebEngineCookieStore::setCookieFilter(std::function<bool(const FilterReque
     \inmodule QtWebEngineCore
     \since 5.11
 
-    \brief This struct is used in conjunction with QWebEngineCookieStore::setCookieFilter() and is
+    \brief The QWebEngineCookieStore::FilterRequest struct is used in conjunction with QWebEngineCookieStore::setCookieFilter() and is
     the type \a filterCallback operates on.
 
     \sa QWebEngineCookieStore::setCookieFilter()
diff --git a/src/core/api/qwebengineurlschemehandler.cpp b/src/core/api/qwebengineurlschemehandler.cpp
index 6f06b2c6e..b5912703d 100644
--- a/src/core/api/qwebengineurlschemehandler.cpp
+++ b/src/core/api/qwebengineurlschemehandler.cpp
@@ -45,7 +45,7 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QWebEngineUrlSchemeHandler
-    \brief The QWebEngineUrlSchemeHandler is a base class for handling custom URL schemes.
+    \brief The QWebEngineUrlSchemeHandler class is a base class for handling custom URL schemes.
     \since 5.6
 
     To implement a custom URL scheme for QtWebEngine, you first have to create an instance of
diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp
index 26fcf28f7..b7abb13fc 100644
--- a/src/webengine/api/qquickwebengineprofile.cpp
+++ b/src/webengine/api/qquickwebengineprofile.cpp
@@ -958,7 +958,7 @@ QQuickWebEngineSettings *QQuickWebEngineProfile::settings() const
     \property QQuickWebEngineProfile::userScripts
     \since 5.9
 
-    \brief the collection of scripts that are injected into all pages that share
+    \brief The collection of scripts that are injected into all pages that share
     this profile.
 
     \sa QQuickWebEngineScript, QQmlListReference
diff --git a/src/webengine/api/qquickwebengineview.cpp b/src/webengine/api/qquickwebengineview.cpp
index b9ae06aeb..35f797cb1 100644
--- a/src/webengine/api/qquickwebengineview.cpp
+++ b/src/webengine/api/qquickwebengineview.cpp
@@ -1277,7 +1277,7 @@ void QQuickWebEngineView::setBackgroundColor(const QColor &color)
 
 /*!
     \property QQuickWebEngineView::audioMuted
-    \brief the state of whether the current page audio is muted.
+    \brief The state of whether the current page audio is muted.
     \since 5.7
 
     The default value is false.
diff --git a/src/webengine/doc/src/qtwebengine-examples.qdoc b/src/webengine/doc/src/qtwebengine-examples.qdoc
index 1f1780764..24604e3dd 100644
--- a/src/webengine/doc/src/qtwebengine-examples.qdoc
+++ b/src/webengine/doc/src/qtwebengine-examples.qdoc
@@ -28,7 +28,7 @@
 /*!
     \group webengine-examples
     \title Qt WebEngine Examples
-    \brief Examples demonstrating the Qt WebEngine usage
+    \brief Examples demonstrating the Qt WebEngine usage.
     \ingroup all-examples
 
     These examples and demonstrations show a range of different uses for \l{Qt WebEngine},
diff --git a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
index 17c29a126..5e172087d 100644
--- a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
+++ b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
@@ -28,7 +28,7 @@
 /*!
     \qmlmodule QtWebEngine 1.8
     \title Qt WebEngine QML Types
-    \brief Provides QML types for rendering web content within a QML application
+    \brief Provides QML types for rendering web content within a QML application.
     \ingroup qtwebengine-modules
     \ingroup qmlmodules
 
diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index 67f3d7a76..aa1f7be7c 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -905,7 +905,7 @@ QWebEnginePage::QWebEnginePage(QObject* parent)
     \property QWebEnginePage::contentsSize
     \since 5.7
 
-    The size of the page contents.
+    \brief The size of the page contents.
 */
 
 /*!
@@ -1054,7 +1054,7 @@ void QWebEnginePage::setWebChannel(QWebChannel *channel, uint worldId)
 
 /*!
     \property QWebEnginePage::backgroundColor
-    \brief the page's background color behind the document's body.
+    \brief The page's background color behind the document's body.
     \since 5.6
 
     You can set the background color to Qt::transparent or to a translucent
@@ -1105,7 +1105,7 @@ void QWebEnginePage::save(const QString &filePath,
 
 /*!
     \property QWebEnginePage::audioMuted
-    \brief whether the current page audio is muted.
+    \brief Whether the current page audio is muted.
     \since 5.7
 
     The default value is \c false.
@@ -1127,7 +1127,7 @@ void QWebEnginePage::setAudioMuted(bool muted) {
 
 /*!
     \property QWebEnginePage::recentlyAudible
-    \brief the current page's \e {audible state}, that is, whether audio was recently played
+    \brief The current page's \e {audible state}, that is, whether audio was recently played
     or not.
     \since 5.7
 
@@ -2046,7 +2046,7 @@ QUrl QWebEnginePage::requestedUrl() const
 
 /*!
     \property QWebEnginePage::iconUrl
-    \brief the URL of the icon associated with the page currently viewed
+    \brief The URL of the icon associated with the page currently viewed.
 
     By default, this property contains an empty URL.
 
@@ -2060,7 +2060,7 @@ QUrl QWebEnginePage::iconUrl() const
 
 /*!
     \property QWebEnginePage::icon
-    \brief the icon associated with the page currently viewed
+    \brief The icon associated with the page currently viewed.
     \since 5.7
 
     By default, this property contains a null icon. If the web page specifies more than one icon,
diff --git a/src/webenginewidgets/api/qwebengineview.cpp b/src/webenginewidgets/api/qwebengineview.cpp
index 576baad17..966b30100 100644
--- a/src/webenginewidgets/api/qwebengineview.cpp
+++ b/src/webenginewidgets/api/qwebengineview.cpp
@@ -238,7 +238,7 @@ QUrl QWebEngineView::iconUrl() const
 
 /*!
     \property QWebEngineView::icon
-    \brief the icon associated with the page currently viewed
+    \brief The icon associated with the page currently viewed.
     \since 5.7
 
     By default, this property contains a null icon.
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
index 8accdf062..b6c5cb497 100644
--- a/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
@@ -28,7 +28,7 @@
 /*!
     \group webengine-widgetexamples
     \title Qt WebEngine Widgets Examples
-    \brief Examples demonstrating the Qt WebEngine Widgets usage
+    \brief Examples demonstrating the Qt WebEngine Widgets usage.
     \ingroup all-examples
 
     Qt provides an integrated Web browser component based on Chromium, the popular
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index ef1166601..517fdc7d9 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -449,14 +449,14 @@
 
 /*!
     \property QWebEnginePage::hasSelection
-    \brief whether this page contains selected content or not.
+    \brief Whether this page contains selected content or not.
 
     \sa selectionChanged()
 */
 
 /*!
     \property QWebEnginePage::selectedText
-    \brief the text currently selected
+    \brief The text currently selected.
 
     By default, this property contains an empty string.
 
@@ -641,7 +641,7 @@
 
 /*!
     \property QWebEnginePage::title
-    \brief the title of the page as defined by the HTML \c <title> element
+    \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.
@@ -654,7 +654,7 @@
 
 /*!
     \property QWebEnginePage::url
-    \brief the URL of the page currently viewed
+    \brief The URL of the page currently viewed.
 
     Setting this property clears the view and loads the URL.
 
@@ -665,8 +665,8 @@
 
 /*!
     \property QWebEnginePage::requestedUrl
-    \brief the URL that was originally requested to be loaded by the page
-    that is currently viewed
+    \brief The URL that was originally requested to be loaded by the page
+    that is currently viewed.
 
     \note The URL may differ from the one returned by url(), which is the actual
     URL that results from DNS resolution or redirection.
@@ -733,7 +733,7 @@
 
 /*!
     \property QWebEnginePage::zoomFactor
-    \brief the zoom factor for the page content
+    \brief The zoom factor for the page content.
 
     Valid values are within the range from \c{0.25} to \c{5.0}. The default factor is \c{1.0}.
 */
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 1c51a2a52..568e7a63a 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -173,7 +173,7 @@
 
 /*!
     \property QWebEngineView::title
-    \brief the title of the page as defined by the HTML \c <title> element
+    \brief The title of the page as defined by the HTML \c <title> element.
 
     Equivalent to \l {QWebEnginePage::title()}.
 
@@ -182,7 +182,7 @@
 
 /*!
     \property QWebEngineView::url
-    \brief the URL of the web page currently viewed
+    \brief The URL of the web page currently viewed.
 
     Setting this property clears the view and loads the URL.
 
@@ -193,7 +193,7 @@
 
 /*!
     \property QWebEngineView::iconUrl
-    \brief the URL of the icon associated with the page currently viewed
+    \brief The URL of the icon associated with the page currently viewed.
 
     By default, this property contains an empty URL.
 
@@ -202,7 +202,7 @@
 
 /*!
     \property QWebEngineView::hasSelection
-    \brief whether this page contains selected content or not.
+    \brief Whether this page contains selected content or not.
 
     By default, this property is \c false.
 
@@ -211,7 +211,7 @@
 
 /*!
     \property QWebEngineView::selectedText
-    \brief the text currently selected
+    \brief The text currently selected.
 
     By default, this property contains an empty string.
 
@@ -238,7 +238,7 @@
 
 /*!
     \property QWebEngineView::zoomFactor
-    \brief the zoom factor for the view
+    \brief The zoom factor for the view.
 
     Valid values are within the range from \c{0.25} to \c{5.0}. The default factor is \c{1.0}.
 */
-- 
cgit v1.2.3