summaryrefslogtreecommitdiffstats
path: root/doc/trouble.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2013-12-08 13:32:00 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2013-12-08 13:32:00 (GMT)
commit58b2c852b150d75d100f27ea70124631549ba0e1 (patch)
tree5422e64c8e9a739f9cf264598097ae11fe979048 /doc/trouble.doc
parent96efae32552513db2a41e6b498cbd76416769dd6 (diff)
downloadDoxygen-58b2c852b150d75d100f27ea70124631549ba0e1.zip
Doxygen-58b2c852b150d75d100f27ea70124631549ba0e1.tar.gz
Doxygen-58b2c852b150d75d100f27ea70124631549ba0e1.tar.bz2
Bug 719591 - expand_as_defined macro does not properly work
Diffstat (limited to 'doc/trouble.doc')
-rw-r--r--doc/trouble.doc5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/trouble.doc b/doc/trouble.doc
index 3a89922..c71e63d 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -22,6 +22,11 @@
read \ref unix_problems "this section" first.
<li>Doxygen is <em>not</em> a real compiler, it is only a lexical scanner.
This means that it can and will not detect errors in your source code.
+<li>Doxygen has a build in preprocessor, but this works slightly different than
+ the C preprocessor. Doxygen assumes a header file is properly guarded against
+ multiple inclusion, and that each include file is standalone (i.e. it could be placed
+ at the top of a source file without causing compiler errors). As long as this is
+ true (and this is a good design practice) you should not encounter problems.
<li>Since it is impossible to test all possible code fragments, it is
very well possible, that some valid piece of C/C++ code is not handled
properly. If you find such a piece, please send it to me, so I can