Wireshark · Ethereal-dev: [Ethereal-dev] Using doxygen for generating developer documentation?

[Ulf Lamping <ulf.lamping@xxxxxx>]

Hi List!

For quite a while I'm working with doxygen for generating developer 
documentation in various projects. It's working much the same way like 
javadoc and some other similar tools and is available for a lot of 
different platforms released under the GPL and can be found here: 
www.*doxygen*.org.

I think this will be helpful to write some documentation of the internal 
API's, like the things in the proto.h file (e.g. 
proto_tree_add_protocol_format, ...).

Doxygen will scan the sourcefiles like a preprocessor and generates 
documentation of these files. This has the main benefit, that the 
documentation and the source itself is kept at the same place, making it 
much easier to maintain.
It can take the information from the current source files. It also can 
be extended by specially formatted additional information in the C 
comments, like given information about the parameters and return values 
used in a function declaration.

What do other's think of this idea?

Regards, ULFL