Re: gEDA-dev: DOxygen for PCB?

[Stuart Brorson <sdb-at-NOSPAMcloud9_dot_net>]

> Note that the comments are not doxygen compatible; they're parsed by a
> perl script in the docs directory.  If you doxygenify them, you'll
> need to fix the perl script.

Hmmmm, I just looked in the doc directory, but found no Perl script.
I didn't see any documentation creating Perl script anywhere else
either.  What is it called?  Where does it live?  Maybe I'm blind.

> However, it might be easier to follow
> the perl script's convention and use the same script to build the docs
> from it.  That also avoids the need for yet another dependency, and
> integrates the text into our existing documentation structure.

My vision for doxygen is this:  Only the maintainer/developer needs to
run it.  The HTML it generates can be distributed pre-built.

Dan's point about people building from CVS and forgetting about
--enable-maintainer-mode is a good one.  My suggestion for doxygen:
have configure look for it, and if it isn't there, then don't try to
build the doxygen docs.

Stuart


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