Fw: Documenting V3 internals

[Rich Churcher]

Gabriel Dos Reis <Gabriel.Dos-Reis@cmla.ens-cachan.fr> writes:

> Standard hearders documentation for users may include:
> 
>   1) Describe all valid signatures declared there
>   2) List all valid class declarations -- or perhaps definitions but,
>      please nothing about private declarations.
>   3) Nothing about the real file name -- the standard name should
>      suffice (e.g. <iostream>)
>   4) No reference to internal files.
> 
> Documentation for developers may include
> 
>   + internal files organization
>   + shadowing C hearders
>   + reasons for diverging from the standard requirements, if any.
> 
> 
> Is that sensible?

That looks eminently sensible :o)  I'll see about spending a little
time on documentation while I'm away.  Thanks for taking the time to
explain all this.

-- 
Cheers,
Rich.