This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
[v3,trunk] Re: example of killer doxygen formatting
- To: Benjamin Kosnik <bkoz at redhat dot com>
- Subject: [v3,trunk] Re: example of killer doxygen formatting
- From: Phil Edwards <pedwards at disaster dot jaj dot com>
- Date: Thu, 19 Apr 2001 19:19:00 -0400
- Cc: libstdc++ at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- References: <200104190016.f3J0GF109289@fillmore.constant.com>
On Wed, Apr 18, 2001 at 05:16:15PM -0700, Benjamin Kosnik wrote:
>
> check this page out:
>
> http://www.abisource.com/doxygen/class_fp_Container.html
>
> amazing.
Actually easy to turn on, like so. Applied to trunk.
There's a nicer graphics-visualization-generating thingy called 'dot'
that we could require maintainers to download and use; doxygen knows how
to make use of it. Neither AbiSource nor libstdc++ is using it right now.
2001-04-19 Phil Edwards <pme@sources.redhat.com>
* Makefile.am (doxygen): Assume script is missing execute perms.
* Makefile.in: Regenerated.
* docs/doxygen/user.cfg.in: Add class diagrams and source browsing.
Index: Makefile.am
===================================================================
RCS file: /home/pme/Repositories/GCC/gcc/libstdc++-v3/Makefile.am,v
retrieving revision 1.20
diff -u -3 -p -r1.20 Makefile.am
--- Makefile.am 2001/04/11 18:52:28 1.20
+++ Makefile.am 2001/04/19 22:56:32
@@ -48,7 +48,8 @@ check-script-install: $(top_builddir)/mk
doxygen:
-(srcdir=`cd ${top_srcdir}; pwd`; \
outdir=`pwd`; \
- ${srcdir}/docs/doxygen/run_doxygen --mode=user $${srcdir} $${outdir})
+ /bin/sh ${srcdir}/docs/doxygen/run_doxygen \
+ --mode=user $${srcdir} $${outdir})
doxygen-maint:
-(srcdir=`cd ${top_srcdir}; pwd`; \
Index: docs/doxygen/user.cfg.in
===================================================================
RCS file: /home/pme/Repositories/GCC/gcc/libstdc++-v3/docs/doxygen/user.cfg.in,v
retrieving revision 1.2
diff -u -3 -p -r1.2 user.cfg.in
--- docs/doxygen/user.cfg.in 2001/04/04 22:20:52 1.2
+++ docs/doxygen/user.cfg.in 2001/04/19 22:56:32
@@ -118,12 +118,12 @@ INTERNAL_DOCS = NO
# generate a class diagram (in Html and LaTeX) for classes with base or
# super classes. Setting the tag to NO turns the diagrams off.
-CLASS_DIAGRAMS = NO
+CLASS_DIAGRAMS = YES
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
-SOURCE_BROWSER = NO
+SOURCE_BROWSER = YES
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.