summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJüri Valdmann <juri.valdmann@qt.io>2019-02-21 13:23:41 +0100
committerKai Koehne <kai.koehne@qt.io>2019-02-22 13:18:06 +0000
commitfd2acd57df7d62490a9a7c1f7b5b60ae50c51ce6 (patch)
tree813c1dcb4f13b4dab352ade495a334d09798e1d5
parentf5bad87426599ff52e382aa7e0698a7e4b4b62de (diff)
Clarify documentation of QWebEnginePage::title()
Explain what happens when the HTML has no proper <title> defined and clarify the meaning of 'by default': it refers to the state before load()/setUrl()/etc. Fixes: QTBUG-71799 Change-Id: Ib2669007573b3ea53e205d9228237bae392f6f78 Reviewed-by: Michael Brüning <michael.bruning@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc6
-rw-r--r--src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc4
2 files changed, 8 insertions, 2 deletions
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 035b45a6d..ef1166601 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -643,6 +643,12 @@
\property QWebEnginePage::title
\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.
+
+ By default, before any content has been loaded, this property contains an
+ empty string.
+
\sa titleChanged()
*/
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 501959ab9..1c51a2a52 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -173,9 +173,9 @@
/*!
\property QWebEngineView::title
- \brief the title of the web page currently viewed
+ \brief the title of the page as defined by the HTML \c <title> element
- By default, this property contains an empty string.
+ Equivalent to \l {QWebEnginePage::title()}.
\sa titleChanged()
*/