[Openswan dev] Introduction of Doxygen/Javadoc commenting to Openswan 2.x

[Ken Bantoft]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


I've started documenting the various internal functions in the Openswan 
2.x tree with Javadoc style comments.  This means anyone can easily run 
doxygen against the included doc/openswan.cfg Doxygen config file and 
generate API level documentation.

For those unfamiliar with Javadoc, Sun's site has a good introduction @ 
http://java.sun.com/j2se/javadoc/writingdoccomments/

As I work on different parts of the codebase, I'm slowing adding comments
to the various functions I adjust, and I ask other developers to do the
same.

Documentation-only patches are also quite welcome, as there is quite a 
number of functions to document, and it will take some months before it's 
anywhere near complete.

- -- 
Ken Bantoft			VP Business Development
ken at xelerance.com		Xelerance Corporation
sip://toronto.xelerance.com	http://www.xelerance.com

The future is here. It's just not evenly distributed yet. 
        -- William Gibson

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQFAgMeOPiOgilmwgkgRAjjuAKCuxcQy+EBiHXmPT6rEjJrNhjJa4gCeP6CR
vvczr8IEkPheFHikJ4RHoq4=
=bfbm
-----END PGP SIGNATURE-----