[Openvas-devel] Change Request #19: discussion open

[Felix Wolfsteller]

Hi
I opened CR #19 in the hope that we agree on some formatting and documentation 
rules ( http://www.openvas.org/openvas-cr-19.html ).

As I see it, there are no alternatives to doxygen. If we agree on doxygen we 
further have to agree on a doxygen configuration file (as long as 
documentation is local -> trivial) and on a style for the documentation 
blocks itself, as there are several possibilities ( 
http://www.stack.nl/~dimitri/doxygen/docblocks.html ).
I opt for the javadoc-like style ( e.g. @param ).

Note that I myself will not participate in huge discussions about where to put 
a space, a bracket, a newline etc, as the main aim is that we 1) agree on one 
style and 2) gradually bring a consistent look into the OpenVAS code base and 
3) achieve professional documentation.
That means, I will agree to everybody with a strong opinion.

Attached is a first proposal for an example file. It is based on 
slad_install.c and not intended to be compiled.

I would like to open the voting quite soon (I vote +1).

Felix

-- 
Felix Wolfsteller |  ++49-541-335 08 3451  |  http://www.intevation.de/
PGP Key: 39DE0100
Intevation GmbH, Neuer Graben 17, 49074 Osnabrück | AG Osnabrück, HR B 18998
Geschäftsführer: Frank Koormann, Bernhard Reiter, Dr. Jan-Oliver Wagner
-------------- next part --------------
A non-text attachment was scrubbed...
Name: module.c
Type: text/x-csrc
Size: 3648 bytes
Desc: not available
Url : http://lists.wald.intevation.org/pipermail/openvas-devel/attachments/20081119/1e9738e1/module.c