summaryrefslogtreecommitdiffstats
path: root/doc/faq.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:39:36 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>1999-12-15 19:39:36 (GMT)
commitdc2968f7b44b1a219a0695ba80c63cd0d7da0ef1 (patch)
tree46bbaf2d590cf1e2edf1bc86a8d7000a2012dc0d /doc/faq.doc
parent916d6d5c6f6c9d14c4c9a636582671c81447f54a (diff)
downloadDoxygen-dc2968f7b44b1a219a0695ba80c63cd0d7da0ef1.zip
Doxygen-dc2968f7b44b1a219a0695ba80c63cd0d7da0ef1.tar.gz
Doxygen-dc2968f7b44b1a219a0695ba80c63cd0d7da0ef1.tar.bz2
mods for doxygen-0.49-991117
Diffstat (limited to 'doc/faq.doc')
-rw-r--r--doc/faq.doc19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/faq.doc b/doc/faq.doc
index 3d936fe..123671f 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -56,6 +56,25 @@ as <code>PREPROCESSING = YES</code>.
Look at section \ref preprocessing for the answer.
+<li><b>How can I change what's after the <code>#include</code> in class documentation?</b>
+
+You can document your class like
+
+\verbatim
+/*! \class MyClassName include.h path/include.h
+ *
+ * Docs for MyClassName
+ */
+\endverbatim
+
+To make doxygen put <br><br>
+<code>
+#include <path/include.h>
+</code>
+
+in the documentation of the class MyClassName regardless of the name of the actual
+header file in which the definition of MyClassName is contained.
+
</ol>
*/