Re: GNU C++ Library: call for writers

[Jonathan Wakely <cow at compsoc dot man dot ac dot uk>]

On Fri, Feb 01, 2002 at 07:53:41PM -0500, Phil Edwards wrote:

> We need help.  Documenting the Standard C++ Library is a lot of work.
> The present goal is /not/ to provide a complete tutorial on the use
> of the entire library; we are not going to try and reproduce something
> like the comprehensive Josuttis text.  (At least, /I/ don't plan to...)
> The example of std::exception should give you an idea of what we're
> trying to do for now:  a reference, not a textbook.

I'd like to help with this effort, as I've been using doxygen recently and
have discovered how useful it is, and would like to be help the project
but don't feel up to working on the code itself. I've started adding
doxygen hooks to stl_algo.h but have a few questions.

Firstly, Phil, are you already working on stl_algo.h ?
I see you've done stl_agobase.h so don't want to duplicate what you're
doing, but I thought I'd start with a header where I know what several of
its features do, rather than something I've never used.

How careful do I have to be not to plagiarise other docs?
I'm looking at several references (including the standard and SGI docs)
and trying to paraphrase without copying directly, but there are only so
many ways you can describe some operations!
>From my reading of the SGI terms, I could directly lift descriptions from
their docs, provided their copyright info is given, which it already is in
all the relevant libstdc++ headers, right?

Are the SGI and HP copyright notices reproduced in the doxygen docs?
The copyright notices say it must be in the supporting docs, so if they're
not there already is a copyright.cc file needed to contain nothing but
doxygen comments?

Thanks,

Jon