AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Add a section all modules can use for example documentation.

Browse Source 
-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ö <topi.reinio@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
This commit is contained in:
Jerome Pasion 2014-04-08 14:59:37 +02:00 committed by The Qt Project
parent 6b2b0cd41b
commit e14ef58f3d
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/global/config.qdocconf
View File

@ -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

5
doc/global/includes/examples-run.qdocinc Normal file
View File

@ -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}.