This is the mail archive of the libstdc++@sources.redhat.com mailing list for the libstdc++ project.

Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]

Re: Documenting V3 internals

To: Rich Churcher <churcher at ihug dot com dot au>
Subject: Re: Documenting V3 internals
From: Gabriel Dos Reis <Gabriel dot Dos-Reis at cmla dot ens-cachan dot fr>
Date: 27 Nov 2000 02:04:51 +0100
Cc: libstdc++ at sources dot redhat dot com
Organization: CMLA, ENS Cachan -- CNRS UMR 8536 (France)
References: <02f101c05685$84ac5720$2989adcb@mpx.com.au> <m3n1em6zl2.fsf@ihug.com.au> <flaeams0nu.fsf@sel.cmla.ens-cachan.fr> <m3elzy6wox.fsf_-_@ihug.com.au>

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

[...]

| Perhaps you could elaborate, when you have more time?

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.

-- Gaby

Follow-Ups:
- Re: Documenting V3 internals
  - From: Rich Churcher

References:
- Re: Doxygen - another sample, preliminary comments
  - From: Rich Churcher
- Re: Doxygen - another sample, preliminary comments
  - From: Gabriel Dos Reis
- Documenting V3 internals
  - From: Rich Churcher

Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]