Re: Fw: Documenting V3 internals

[Gabriel Dos Reis <Gabriel dot Dos-Reis at cmla dot ens-cachan dot fr>]

Rich Churcher <churcher@ihug.com.au> writes:

[...]

| What was your opinion of the idea to provide a set of documentation
| centred around the standard headers?

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?

Thanks,

-- Gaby