[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
gEDA-user: comments in gaf source
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:
http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x6C0B9F53
_______________________________________________
geda-user mailing list
geda-user@xxxxxxxxxxxxxx
http://www.seul.org/cgi-bin/mailman/listinfo/geda-user