Re: gEDA-dev: Question for Peter about documentation pragma

[Carlos Nieves Ónega <cnieves.mail@xxxxxxxxx>]

El vie, 06-04-2007 a las 18:44 +0100, Peter Clifton escribiÃ:
> On Fri, 2007-04-06 at 13:33 -0400, Stuart Brorson wrote:
> > Peter --
> > 
> > I see you've been using some kind of documentation pragma in your
> > patches.  Here's an example:
> > 
> >    /*! \brief Register some libgeda variables with scheme.
> >     *  \par Function Description
> >     *  Define some variables to be visible to Scheme.
> >     */
> 
> That is Carlos's I believe.

Yes, that was me. I just followed the existing documentation convention.
Doxygen allows you to use several formats:

http://www.stack.nl/~dimitri/doxygen/docblocks.html

And that format was the one used since the noweb transition:
http://www.geda.seul.org/mailinglist/geda-dev84/msg00082.html

The documentation is generated executing:
  - make doxygen   in libgeda/docs
  - make doxygen   in gschem/docs

Regards,

Carlos




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