Biot Olivier wrote:
Hi list,
Now Doxygen is used to generate documentation for only the source files in
epan. Are there any plans to add *all* source into the Doxygen documentation
(maybe one separated for the wiretap code)?
As this was a first try to use doxygen for Ethereal, I wanted to start
with the epan files, as these will be used by most dissector developers.
Of course we could make documentation of the whole Ethereal sources, or
other parts like the wiretap code.
There are two main reasons that it might not be a good idea to put all
sources into one documentation:
-it will need very long time to generate (annoying when writing
documentation comments) and even more important:
-the documentation will become very very large, thus make it complex and
confusing to find things in
So the parts of documentation I currently see is:
-root (all the dissectors and other common code)
-epan
-gtk (ethereal)
-wiretap
There is an include mechanism in doxygen, so only one big configuration
file is needed with all the common settings. This can be included into
the much smaller configuration files for each of the parts, containing
only the differences.
However, the documentation in epan I've done is only a start. It's one
thing to get a list of files and functions (which is easy to get with
doxygen), but another thing to have a good API documentation, with all
parameters and return values explained (which makes the documentation
really useful). I've tried to start in epan/proto.h, but didn't even
finished this file completely.
Any comments welcome.
Regards, ULFL
