RE: [boost] Reference documentation: one approach

From: David Bergman (davidb_at_[hidden])
Date: 2002-10-30 20:35:16

Hi, all.

I used to do *a lot of* LaTeX macroing back then, and can probably catch
up if noone else volunteers ;-)

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(?))?

Such a (wish) list would be helpful anyway. Of course, the list should
be in a highly abstract syntax (i.e., no "\begin{classheader}[3]{}...")
so we can either (1) implement the list (in LaTeX or other) or (2) check
the presence of those constructs in an existing macro package (again,
Doxygen?)

I would prefer naming the list "Tag List" to not confuse it with the
programming macro facilities found in C++.

In the absence of such a list, I would probably steal some common tags
from Javadoc and Doxygen and add some other template-specific tags. One
important note, from Bill and others, is that a "literate programming
system" should enable inserting documentation tags in the middle of
methods, which affect the set of tags in the "Tag List".

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

David "Why Develop When You Can Document" Bergman

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

On Wednesday 30 October 2002 05:38 am, Anthony Williams wrote:
> I found it remarkably easy to learn to _write document_ using LaTeX 
> --- it is learning to write macros that is tricky, and thankfully, we 
> should only have to do that once at the beginning (to write a boost 
> LaTeX class), and then small maintenance issues as people want to add 
> more stuff.

Do we have a volunteer to prototype a little bit of this system so we
can 
determine if it is feasible? My own encounters with writing LaTeX macros
have 
been less than satisfying, though actually writing documents in LaTeX is
a 
joy (read: I'm not volunteering to write the macros, but I wouldn't mind

using a LaTeX-based system if that turns out for the best).

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