RE: doxygen redux

[Greg Bumgardner <bumgard at roguewave dot com>]

I know of a couple of ways to reduce the amount of documentation produced by
doxygen:

- Disable the generation of any inheritance and collaboration diagrams
(produces gif files).
- Disable source documentation options which include annotated source code
in the documentation (both inline or as separate files). This effectively
replicates all of the source code.
- Hide private class members (we'd probably want two documentation setups;
one for end-users and one for maintainers).

I agree that that documentation generation should probably be treated as a
"maintainer-only" option (which would only work if configure finds doxygen
in the build environment). The actual documentation could actually be
regenerated as necessary by V3 developers and checked into CVS just like the
configure-make-related files are now. 

As for dependencies, doxygen uses some utility classes from the Qt library
so it needs access to this library.  Doxygen also includes a GUI
configuration file editor that uses the Qt library, but I've never found a
need to use it. I think that the binary distributions of Doxygen include a
static version of this library. I also seem to recall that doxygen requires
some GNU utilities such as bison and flex.

Anyway, let me know if I can be of any assistance in getting doxygen up and
running on V3...

-g.b.

+---------------------------+
| Greg Bumgardner           |
| Senior Software Architect |
| Rogue Wave Software       |
| bumgard%roguewave:com     |
+---------------------------+

> -----Original Message-----
> From: Phil Edwards [mailto:pedwards@disaster.jaj.com]
> Sent: Saturday, February 24, 2001 7:33 PM
> To: libstdc++@gcc.gnu.org
> Subject: Re: doxygen redux
> 
> 
> On Fri, Feb 23, 2001 at 03:27:51PM -0800, Benjamin Kosnik wrote:
> > 
> > did anybody else see that abiword started using doxygen? seems like
> > they have scripts that auto-gen this stuff. Anyway this 
> could be used with v3?
> 
> I couldn't find the scripts you mention.  (Are you talking 
> about scripts
> to generate the comments in the source, or something else?)
> 
> Basically there have only been two things keeping me from setting up
> Doxygen for v3:  first, the pre-req tools that doxygen needs 
> is rather long.
> Obviously this is something that only v3 maintainers would be 
> expected to
> run.  I consider myself a utility freak and I still had to go 
> download stuff.
> 
> Secondly, behavior is entirely controlled by the
> configuration file, which
> is huge.  I've never had the time to write one, or to modify 
> one of the
> examples shipped with Doxygen.  The guy who originally 
> mentioned Doxygen
> on this list was going to "look it over" and then had to 
> leave for 2 weeks,
> but was never heard from again.  I suspect he fell into the 
> Doxygen manual.
> 
> That second point is really all we need to overcome.  I 
> grabbed the config
> file for abiword and made a couple of obvious changes, then I 
> ran it on
> v3 as an experiment.  It generated 13MB of LaTeX and 39MB of HTML.
> 
> No, there is no typo in the previous sentence.  >> 39 megs << of HTML
> files.[*] Clearly the config file needs some trimming but we 
> must first
> decide what we're using this for, e.g., if we don't want to 
> document the
> internals, lots of stuff can be ignored.  The experimental file I used
> documents /everything/ in the tree.
> 
> 
> Phil
> [*] All in a flat directory, too.  I had to apologize to /bin/ls.
> 
> -- 
> pedwards at disaster dot jaj dot com  |  pme at sources dot 
> redhat dot com
> devphil at several other less interesting addresses in 
> various dot domains
> The gods do not protect fools.  Fools are protected by more 
> capable fools.
>