summaryrefslogtreecommitdiffstats
path: root/src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc')
-rw-r--r--src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc b/src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc
index 4289f357e9..20e0b86b6c 100644
--- a/src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc
+++ b/src/tools/qdoc/doc/qdoc-minimum-qdocconf.qdoc
@@ -26,12 +26,15 @@
****************************************************************************/
/*!
\page qdoc-minimum-qdocconf.html
-\title A minimal qdocconf file with comments
+\title A minimal qdocconf file with Comments
\brief Describes a minimal .qdocconf file
-Below you will find the full contents of qtgui.qdocconf. The subsequent section will discuss
-every statement in the qdocconf file.
+Below you will find the full contents of qtgui.qdocconf. The subsequent section
+will discuss every statement in the qdocconf file.
+
+Each line from the qdocconf file is first quoted. Below each statement you will
+find the meaning.
\code
#include(compat.qdocconf)
@@ -83,4 +86,6 @@ The source code of the example files can be found in the current directory.
The image files can be found in the underlying directory "images".
+\note Please take care with this minimal qdocconf file. Using it in the wrong directory
+could cause qdoc to include a large number of files.
*/