RE: [boost] Reference documentation: one approach

From: David Bergman (davidb_at_[hidden])
Date: 2002-10-30 23:22:37

Till someone else volunteers (where are all the LaTeX people hiding?), I
will gather possible macros (or environments) from the Doxygen output
and your XSLT/XML prototype then. Hopefully, I will have a sample style
soon.

/David

-----Original Message-----
From: boost-bounces_at_[hidden]
[mailto:boost-bounces_at_[hidden]] On Behalf Of Douglas Gregor
Sent: Wednesday, October 30, 2002 10:49 PM
To: Boost mailing list
Subject: Re: [boost] Reference documentation: one approach

On Wednesday 30 October 2002 08:35 pm, David Bergman wrote:
> I used to do *a lot of* LaTeX macroing back then, and can probably 
> catch up if noone else volunteers ;-)

Sold!

> Does anyone have an idea of what macros we would need (the actual 
> enumeration could be stolen from some existing C++ "literation" 
> system, such as Doxygen(?))?

Well, I picked a set of constructs for the XSLT/XML prototype. You're
welcome 
to steal those if you'd like, or completely ignore them and go with
something 
better :). Here's a possible LaTeXified fragment:

\begin{namespace}{boost}
  \begin{class}{function}
    \templateparam{Signature}
    \templateparam{Allocator}[std::allocator<void>]
    \typedef{Allocator}{allocator_type}
  \end{class}
\end{namespace}

> It feels terrible referring to Doxygen when I have never touched it. I

> just hope it is as close to Javadoc as I extrapolate from the 
> discussion...

They're _very_ close.

        Doug
_______________________________________________
Unsubscribe & other changes:
http://lists.boost.org/mailman/listinfo.cgi/boost