Improved documentation of Text.textFormat property.

Even though using RichText is not recommended, we should still at least
point out what it does.

Change-Id: I96d0e1e7074b5fdbb3a5dcaf84e5afe805c92080
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>

diff --git a/src/quick/items/qquicktext.cpp b/src/quick/items/qquicktext.cpp
index 14c386d..01136d5 100644 (file)
--- a/src/quick/items/qquicktext.cpp
+++ b/src/quick/items/qquicktext.cpp
@@ -1908,7 +1908,7 @@ void QQuickText::resetMaximumLineCount()
     there is no guarantee.
 
     Text.StyledText is an optimized format supporting some basic text
-    styling markup, in the style of html 3.2:
+    styling markup, in the style of HTML 3.2:
 
     \code
     <b></b> - bold
@@ -1951,6 +1951,10 @@ Column {
     \endqml
     \li \image declarative-textformat.png
     \endtable
+
+    Text.RichText supports a larger subset of HTML 4, as described on the
+    \l {Supported HTML Subset} page. You should prefer using Text.PlainText
+    or Text.StyledText instead, as they offer better performance.
 */
 QQuickText::TextFormat QQuickText::textFormat() const
 {