Re: [boost] Re: Reference documentation: one approach

From: Mattias Flodin (flodin_at_[hidden])
Date: 2002-10-31 02:44:24

On Wed, Oct 30, 2002 at 07:21:05PM +0000, Alisdair Meredith wrote:
> This illustrates my main issue with doxygen the time we flirted with
> it.  It almost entirely obscures the source.  Where before I could read
> a header file as simplified documentation, now I have a huge
> comment-to-source ratio making it very hard to pick out  information
> quickly and easily.  When I need this detailed view, I turn to the
> documentation (when available) but the majority of the time I prefer the
> 'cleaner' header file.  With doxygen I have no choice but to wade
> through moderately detailed documentation at all times.

I second this. Why is there really a need to have all the documentation
in the source at all? What difficulties are introduced by writing the
documentation in a separate window?

-- 
Mattias Flodin <flodin_at_[hidden]>  -  http://www.cs.umu.se/~flodin/
Room NADV 102
Department of Computing Science
Umeå University
S-901 87 Umeå, Sweden
--
You see, wire telegraph is a kind of a very, very long cat. You pull his tail
in New York and his head is meowing in Los Angeles. Do you understand this?
And radio operates exactly the same way: you send signals here, they receive
them there. The only difference is that there is no cat.
  -- Albert Einstein