On Donnerstag, 11. Dezember 2008, Matthew Mundell wrote:
> Secondly, how about turning on Doxygen JAVADOC_AUTOBRIEF? This allows
> forms such as
>
> /** Free any server rules. */
> void
> maybe_free_server_rules ()
> ...
>
> in place of
>
> /**
> * @brief Free any server rules.
> */
> void
> maybe_free_server_rules ()
> ...
the latter form clearly says we use doc method to a novice developer.
>From the first version you don't really know.
I always prefer self-explaining approaches. Probably because I am too
lazy to read manuals before digging into something ;-)
Best
Jan
--
Dr. Jan-Oliver Wagner | ++49-541-335 08 30 | http://www.intevation.de/
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
_______________________________________________
Openvas-devel mailing list
Openvas-devel@wald.intevation.org
http://lists.wald.intevation.org/mailman/listinfo/openvas-devel
