From: Geoffrey B. <geo...@ai...> - 2008-02-27 00:08:17
|
Alexei Makarenko wrote: >> Documentation: >> - More comments in some of the various utility headers briefly >> mentioning what each file is for would allow others to use them more >> easily and thus potentially lead to them being promoted up to the top level. > > I intentionally turned the existing documentation off when moving from > Hydro to make a clear distinction between the external API (which is > documented and is subject to review) and the internal tools. does it > make sense? That's actually a good point that I didn't think of. The online documentation probably should be aimed squarely at users, not people investigating the code. Up to the library maintainer, I think. Geoff |