diff options
authorJerome Pasion <>2014-04-08 14:59:37 +0200
committerThe Qt Project <>2014-04-09 10:37:29 +0200
commite14ef58f3d222004c82279be5461cde755b4239d (patch)
parent6b2b0cd41b5a75f5a1f6e8c0313f2e9cce55e64e (diff)
Doc: Add a section all modules can use for example documentation.
-modules that use the qt-module-defaults.qdocconf have access to the .qdocinc file. -content about running examples can be used by example documentation. Task-number: QTBUG-33597 Change-Id: I88d93a9982c05a24b4f7ac1b2cfb3293e56031b2 Reviewed-by: Topi Reiniƶ <> Reviewed-by: Leena Miettinen <>
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf
index 8629b89e7e..670b13a9ea 100644
--- a/doc/global/config.qdocconf
+++ b/doc/global/config.qdocconf
@@ -10,3 +10,5 @@ dita.metadata.default.audience = programmer
#Set the main Qt index.html
navigation.homepage = "Qt $QT_VER"
buildversion = "Qt $QT_VERSION Reference Documentation"
+sourcedirs += includes
diff --git a/doc/global/includes/examples-run.qdocinc b/doc/global/includes/examples-run.qdocinc
new file mode 100644
index 0000000000..e9b8575650
--- /dev/null
+++ b/doc/global/includes/examples-run.qdocinc
@@ -0,0 +1,5 @@
+\section1 Running the Example
+To run the example from \l{Qt Creator Manual}{Qt Creator}, open the \gui Welcome
+mode and select the example from \gui Examples. For more information, visit
+\l{Qt Creator: Building and Running an Example}{Building and Running an Example}.