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.
As for keeping your syntax, well I can do that in places. However, my
plan -- at least to start -- was to just fix the comments to use /**,
and then perhaps add some simple text for each fcn. Going whole hog
and following your syntax will take longer. The vision would
be that then, over time, other developers (and me too) would just add
to the doxygen comments which I started, and the whole thing would
grow organically from there.
I'll submit some patches tonight (via SF) and you can judge if I am
doing good or harm.
Stuart
_______________________________________________
geda-dev mailing list
[email protected]
http://www.seul.org/cgi-bin/mailman/listinfo/geda-dev
