On Wednesday 09 October 2002 07:39 am, Matthijs Hollemans wrote: > > i was thinking it could be nice if someone wrote a good doxygen > > tutorial for > > > the newsletter.. something that will include producing quality > > html docs, > > > making config files, etc. > > It would also be nice if such a tutorial included an explanation > about _what_ exactly should be documented: only the public API (in > which case the doxygen-generated docs effectively replace the > BeBook), only the implementation (anything except the public > headers), or both? (And also, which license text people should put > at the top of their source files -- right now almost every file has > a different copyright notice :-) I've used Doxygen before, for both commercial and personal software projects, this would probably require a series of articles spanning several newsletters to get a decent tutorial working. Either that, or risk one incredibly long newsletter where folks are likely to tune out before finishing the tutorial. When you say "only the public API" -- I'm assuming you also include class attributes in that list? OBOS isn't a black box like Be is. Cheers, Scott