Re: gEDA-dev: DOxygen for PCB?

[Dan McMahill <dan-at-NOSPAMmcmahill_dot_net>]

Stuart Brorson wrote:
>>> Question:  If I continue doing this work, would you be willing to
>>> check the changes in?
>>
>> Note that we already have comments which are parsed to form our
>> existing documentation, see action.c for an example.  Why not continue
>> with that syntax?  Otherwise, as long as you don't break the doc
>> tools, I have no problem with people adding comments ;-)
> 
> Yeah, I found the stuff in action.c after I posted.  I'll remind
> myself to "look first, then post" next time!
> 
> In any event, the action.c stuff wasn't showing up when I ran doxygen
> on my box.  I believe it was because the comments weren't prefaced by
> /** (they were /* instead), so my config of doxygen wasn't noticing
> them.  Perhaps you guys use a different config file?  In any event, I
> am happy to change the comments to /** style.

We're not currently using doxygen.  All of the sections of the texinfo 
manual that described file formats and actions are extracted from the 
comments in the code by a perl script that DJ wrote.  The perl script 
extracts the information and produces a .texi file which is included in 
the building of the manual.  It has been most useful because now the 
documentation for the actions and the file format should be complete and 
accurate.  We even have a good shot at keeping it that way too!

I guess I don't know enough about doxygen to comment on how it would or 
wouldn't help out.

-Dan




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