diff options
| author | Kai Koehne <kai.koehne@qt.io> | 2019-02-21 17:01:03 +0100 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@qt.io> | 2019-02-22 13:18:08 +0000 |
| commit | 598bfc652edffb047948e01c3c76eb9e0cb7db4e (patch) | |
| tree | 793e5ca06d3a24e119be07a05ff5edd2de489533 /src/webengine | |
| parent | fd2acd57df7d62490a9a7c1f7b5b60ae50c51ce6 (diff) | |
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>
Diffstat (limited to 'src/webengine')
| -rw-r--r-- | src/webengine/api/qquickwebengineprofile.cpp | 2 | ||||
| -rw-r--r-- | src/webengine/api/qquickwebengineview.cpp | 2 | ||||
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-examples.qdoc | 2 | ||||
| -rw-r--r-- | src/webengine/doc/src/qtwebengine-qmlmodule.qdoc | 2 |
4 files changed, 4 insertions, 4 deletions
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 |