Documenting V3 internals
Jason Merrill
jason@redhat.com
Mon Nov 27 06:03:00 GMT 2000
>>>>> "Rich" == Rich Churcher <churcher@ihug.com.au> writes:
> Gabriel Dos Reis <Gabriel.Dos-Reis@cmla.ens-cachan.fr> writes:
> [ snip ]
>> Users should not concern themselves with the library's internals -- all
>> they need is the library's observable behaviour. Users have no
>> business in knowing how we actually provide the services contracted
>> through the interfaces. As such, there is no point in providing users
>> with any documentation mentioning which internal files do which jobs.
> The idea of not providing as much detail as is available on library
> internals strikes me as an attitude more suited to a commercial
> project than an open source effort.
I agree. The more extensive the documentation, the better, though I
certainly wouldn't object to separating the usage and implementation
sections (as in the GCC documentation).
Jason
More information about the Libstdc++
mailing list