Re: [boost] Reference documentation: one approach

From: Ken Shaw (ken_at_[hidden])
Date: 2002-10-30 11:35:28

----- Original Message -----
From: "David Abrahams" <dave_at_[hidden]>
To: "Boost mailing list" <boost_at_[hidden]>
Sent: Tuesday, October 29, 2002 10:13 PM
Subject: Re: [boost] Reference documentation: one approach

> "Ken Shaw" <ken_at_[hidden]> writes:
>
> > From: "Neal D. Becker" <nbecker_at_[hidden]>
> >
> > > Doxygen is great for documenting interfaces.  It does not help with
> > > any other documentation as far as I can tell.
> >
> > While doxygen is mostly used for documenting interfaces it can be used
for
> > kinds of documentation as well.
> >
> > You can include any sort of text at most any level of the documentation.
Our
> > internal XML library is extensively documented including how-to's,
examples,
> > known bugs, feature wish lists and to-do lists at the library, file, and
> > class levels, all of which is generated by doxygen.
> >
> > I would be happy to doxygenize a smallish Boost project to demonstrate.
>
> Doxygen has always failed miserably at understanding template code
> I've generated of any complexity. Worse, it's written in Perl, which I
> personally find incomprehensible ;-/.
>

I've never encountered this problem. Could you send me some code that you
think doxygen can't handle or point me to what type of construct you've seen
this with?

Ken Shaw