Troubleshooting
Known problems:
- Doxygen is not a compiler, it is only a lexical scanner. This means that it can and will not detect errors in your source code.
- Since it 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 improve doxygen's parsing capabilities. Try to make the piece of code you send as small as possible, to help me narrow down the search.
- Using declarations and directives are not yet. They are simply ignored.
- Doxygen does not work properly if there are multiple classes, structs or unions with the same name in your code. It should not crash however, rather it should ignore all of the classes with the same name except one.
- Some commands do not work inside the arguments of other commands. Inside a HTML link (i.e <a href="...">...<a>) for instance other commands (including other HTML commands) do not work! The sectioning commands are an important exception.
- Redundant braces can confuse doxygen in some cases. For example: is properly parsed as a function declaration, but is also seen as a function declaration, because only the syntax is analysed, not the semantics. If the redundant braces can be detected, as in then doxygen will remove the braces and correctly parse the result.
How to help
The development of Doxygen highly depends on your input!
If you are trying Doxygen let me know what you think of it (do you miss certain features?). Even if you decide not to use it, please let me know why.
Furthermore, I would appreciate a mail if you have found a bug, or if you have ideas (or even better some code or a patch) how to fix existing bugs and limitations.
The easiest way for me to solve bugs is if you can send me a small example demonstrating the problem you have (make sure the example compiles!). It is usually a good idea to send along the configuation file as well, but please use doxygen with the -s
flag while generating it.
My email address: dimitri@stack.nl
Generated at Thu Sep 2 10:53:31 1999 by
written by Dimitri van Heesch, © 1997-1999