This is the mail archive of the
libstdc++@sources.redhat.com
mailing list for the libstdc++ project.
Re: Fw: Documenting V3 internals
- To: Gabriel Dos Reis <Gabriel dot Dos-Reis at cmla dot ens-cachan dot fr>
- Subject: Re: Fw: Documenting V3 internals
- From: Rich Churcher <churcher at ihug dot com dot au>
- Date: 29 Nov 2000 12:39:30 +1100
- Cc: libstdc++ at sources dot redhat dot com
- References: <00f701c058b8$0a621240$cd93adcb@mpx.com.au><m3pujhnfvo.fsf@ihug.com.au> <fl8zq4x63r.fsf@sel.cmla.ens-cachan.fr>
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.