From 598bfc652edffb047948e01c3c76eb9e0cb7db4e Mon Sep 17 00:00:00 2001 From: Kai Koehne 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 --- .../doc/src/qtwebenginewidgets-examples.qdoc | 2 +- src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc | 14 +++++++------- src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc | 12 ++++++------ 3 files changed, 14 insertions(+), 14 deletions(-) (limited to 'src/webenginewidgets/doc') 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 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