Re: [boost] Reference documentation: one approach

From: Douglas Gregor (gregod_at_[hidden])
Date: 2002-10-30 22:48:56

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