Re: gEDA-user: comments in gaf source

[Ethan Swint <eswint.ramu@xxxxxxxxxxx>]

   Are the Doxygen docs for gaf published on the web/internet?
   On 07/21/2009 02:46 PM, Stuart Brorson wrote:

DOxygen

[1]http://www.stack.nl/~dimitri/doxygen/

Stuart



On Tue, 21 Jul 2009, Kai-Martin Knaak wrote:



In the c-code of gaf I see some non standard comment syntax. E.g

/*! whatever */

or

/* ! \brief  foobar */

or

/** @brief foo
*
* @param bar
*/

or even more detailed:

/*! \file foo.c
*  \brief bar
*
*  lots-of-commenting-text
*
*  \image foobar.png
*  \image latex barfoo.pdf "page overview" width=14cm
*/


I guess, this allows some funky tools to automatically extract a
documentation. Can somebody enlighten me with the details?
Are these formated comments recommended or depreciated for new code?

---<(kaimartin)>---
--
Kai-Martin Knaak
?ffentlicher PGP-Schl?ssel:
[2]http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x6C0B9F53



_______________________________________________
geda-user mailing list
[3]geda-user@xxxxxxxxxxxxxx
[4]http://www.seul.org/cgi-bin/mailman/listinfo/geda-user



_______________________________________________
geda-user mailing list
[5]geda-user@xxxxxxxxxxxxxx
[6]http://www.seul.org/cgi-bin/mailman/listinfo/geda-user

References

   1. http://www.stack.nl/~dimitri/doxygen/
   2. http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x6C0B9F53
   3. mailto:geda-user@xxxxxxxxxxxxxx
   4. http://www.seul.org/cgi-bin/mailman/listinfo/geda-user
   5. mailto:geda-user@xxxxxxxxxxxxxx
   6. http://www.seul.org/cgi-bin/mailman/listinfo/geda-user


_______________________________________________
geda-user mailing list
geda-user@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-user