Re: [boost] Reference documentation: one approach

From: William E. Kempf (wekempf_at_[hidden])
Date: 2002-10-29 10:58:45

Stefano Delli Ponti said:
>
> ----- Original Message -----
> From: "David Abrahams" <dave_at_[hidden]>
> To: "Boost mailing list" <boost_at_[hidden]>
> Sent: Tuesday, October 29, 2002 4:04 PM
> Subject: Re: [boost] Reference documentation: one approach
>
>> I very much dislike the idea of having the /source/ of our docs be in
>> any kind of <tag>...</tag> representation. I would like to explore a
>> more-readable (and typable) alternative: ReStructuredText.
>>
>>    http://docutils.sourceforge.net/docs/rst/quickref.html
>
> I suggest Doxygen.
> http://www.stack.nl/~dimitri/doxygen/

Been discussed before, and some of our developers do use this.  I've used
it for non-Boost stuff.

But Doxygen isn't going to work for our Boost documentation.  We go well
beyond reference documentation, and at that point Doxygen becomes more of
a hurdle than a help.

-- 
William E. Kempf