summaryrefslogtreecommitdiffstats
path: root/doc/faq.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2001-02-25 17:49:47 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2001-02-25 17:49:47 (GMT)
commit69fbf29b9b2be1bdf9132adb799f31ab343a642e (patch)
tree0673a1c66696ceb0da0191a0e834b85eef8c50a2 /doc/faq.doc
parent863353b89b228b87789e6d6c9257605acd796fff (diff)
downloadDoxygen-69fbf29b9b2be1bdf9132adb799f31ab343a642e.zip
Doxygen-69fbf29b9b2be1bdf9132adb799f31ab343a642e.tar.gz
Doxygen-69fbf29b9b2be1bdf9132adb799f31ab343a642e.tar.bz2
Release-1.2.5-20010225
Diffstat (limited to 'doc/faq.doc')
-rw-r--r--doc/faq.doc38
1 files changed, 28 insertions, 10 deletions
diff --git a/doc/faq.doc b/doc/faq.doc
index 5f38837..4245a74 100644
--- a/doc/faq.doc
+++ b/doc/faq.doc
@@ -35,6 +35,33 @@ You should use the \\mainpage command inside a comment block like this:
*/
\endverbatim
+<li><b>Help, some/all of the members of my class / file / namespace
+ are not documented?</b>
+
+ Check the following:
+ <ol>
+ <li>Is your class / file / namespace documented? If not, it will not
+ be extracted from the sources unless \c EXTRACT_ALL is set to \c YES
+ in the config file.
+ <li>Are the members private? If so, you must set \c EXTRACT_PRIVATE to \c YES
+ to make them appear in the documentation.
+ <li>Is there a function macro in your class that does not end with a
+ semicolon (e.g. MY_MACRO())? If so then you have to instruct
+ doxygen's preprocessor to remove it.
+
+ This typically boils down to the following settings in the config file:
+
+ \verbatim
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = YES
+PREDEFINED = MY_MACRO()=
+ \endverbatim
+
+ Please read the \ref preprocessing "preprocessing" section of the
+ manual for more information.
+ </ol>
+
<li><b>When I set EXTRACT_ALL to NO non of my functions are shown in the documentation.</b></li>
In order for global functions, variables, enums, typedefs, and defines
@@ -64,10 +91,6 @@ around the blocks that should be hidden and put:
in the config file then all blocks should be skipped by Doxygen as long
as <code>PREPROCESSING = YES</code>.
-<li><b>How can I make doxygen ignore nasty macro's? </b>
-
-Look at section \ref preprocessing for the answer.
-
<li><b>How can I change what's after the <code>\#include</code> in the class documentation?</b>
You can document your class like
@@ -145,15 +168,10 @@ The most important reason is too have a platform abstraction for most
Unices and Windows by means of the QFile, QFileInfo, QDir, QDate,
QTime and QIODevice classes.
Another reason is for the nice and bug free utility classes, like QList,
-QDict, QString, QArray, QTextStream, QRegExp etc.
+QDict, QString, QArray, QTextStream, QRegExp, QXML etc.
The GUI front-end doxywizard uses Qt for... well... the GUI!
-<li><b>Can I use doxygen on my Java code?</b>
-
-No, at the moment there is no support for Java. I suggest to
-use Sun's JavaDoc instead.
-
<li><b>How can I exclude all test directories from my directory tree?</b>
Simply put an exclude pattern like this in the configuration file: