summaryrefslogtreecommitdiffstats
path: root/src/corelib/doc/src/includes
diff options
context:
space:
mode:
Diffstat (limited to 'src/corelib/doc/src/includes')
-rw-r--r--src/corelib/doc/src/includes/qdebug-toString.qdocinc7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/corelib/doc/src/includes/qdebug-toString.qdocinc b/src/corelib/doc/src/includes/qdebug-toString.qdocinc
new file mode 100644
index 0000000000..4602a10511
--- /dev/null
+++ b/src/corelib/doc/src/includes/qdebug-toString.qdocinc
@@ -0,0 +1,7 @@
+Streams \a object into a QDebug instance that operates on a string,
+and then returns that string.
+
+This function is useful for cases where you need the textual representation
+of an object for debugging, but cannot use \c {operator<<}. For example:
+
+\snippet code/src_corelib_io_qdebug.cpp toString