RE: [boost] Re: Reference documentation: one approach

From: David Bergman (davidb_at_[hidden])
Date: 2002-11-01 17:09:26

Dave,

Did you have such a "patched" version of Synpsis somewhere? I could not
get Synposis to work "out-of-the-box".

I used Doxygen to produce HTML (directly) and PDF (through pdftex)
documentation of the 1.29 version of Boost.Python. It was not a very
interesting document... Doxygen seems to not acknowledge templates as
"compounds", so one basically get a list of the files involved in the
project. Not very useful for Boost, in other words. I used it in
non-template libraries, and with other languages, and it is quite good,
with inlined code, keeping the links.

It is a pitty that the Doxygen group has not put much effort in handling
templates, since Doxygen is a more supported tool than Synopsis. I think
the Boost group has to more or less adopt Synopsis to make it viable as
a documentation generator...

My goal was to use a "tag- and structure-extractor" such as Doxygen or
Synopsis to generate either LaTeX or DocBook, and then merge other
documentation in that format, such as the specification, to in the end
create HTML and PDF output. All this is possible in both Synopsis and
Doxygen as it seems, although one would need to either use the
experimental XML output of Doxygen with some DocBook-generating XSLTs,
and use OpenJade, db2tex+pdftex or FOP to do the DocBook-->PDF and
pdftex to do the LaTeX-->PDF.

/David

-----Original Message-----
From: boost-bounces_at_[hidden]
[mailto:boost-bounces_at_[hidden]] On Behalf Of David Abrahams
Sent: Thursday, October 31, 2002 12:27 AM
To: Boost mailing list
Cc: Stephen Davies
Subject: Re: [boost] Re: Reference documentation: one approach

>From Stephen Davies:

---
On Thu, 2002-10-31 at 01:59, David Abrahams wrote:
> nbecker_at_[hidden] (Neal D. Becker) writes:
> 
> > I am interested in synopsis.  Is it useable at this point?
> 
> I am certainly finding it to be so. Installing it is "interesting" but
> I think we can get you going without too much effort.
I know you had a few problems David, but I was able to get it working on
cygwin by just installing GraphViz from exptools (I searched for
graphviz and cygwin) and Synopsis from CVS. It seems the graphviz
binaries included freetype.
---
FWIW, This is all *after* Stephen and I made substantial changes to get
it working on Cygwin. My initial experience wasn't quite so smooth, but
things are working nicely now.
_______________________________________________
Unsubscribe & other changes:
http://lists.boost.org/mailman/listinfo.cgi/boost