This is the mail archive of the libstdc++@gcc.gnu.org mailing list for the libstdc++ project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

RE: doxygen redux


> - 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).

thanks for the tips!

> 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. 

Right, sounds good. So, a conditional 'make doxygen' rule in the top-level 
makefile?

> 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.

Requiring this stuff is less of a burden if only maintainers need to deal 
with it.

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

I think the stumbling block is how to automate the runs. I don't mind 
reformatting all the comments and everything if the end product is really 
nice documentation...

Here's the archive of some of the past discussions:

http://gcc.gnu.org/ml/libstdc++/2000-12/msg00058.html
http://gcc.gnu.org/ml/libstdc++/2000-11/msg00220.html
http://gcc.gnu.org/ml/libstdc++/2000-11/msg00181.html

-benjamin


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]