FreeLists / openbeosnetteam / [openbeosnetteam] Documentation update

[Brennan Cleveland <warriorspot@xxxxxxxxxxxxx>]

Hi Network and Kernel teams!

Here is a quick update on the documentation project:

I have created preliminary Doxygen documentation for most of the core 
OBOS files (the kits and core kernel).  I basically created a generic 
Doxyfile for each appropriate directory and let Doxygen extract 
everything it could.  It did a really good job in my opinion.  Anyway, 
the job remains to actually document the source files with Doxygen 
specific formatting, so as to have all the short and detailed 
descriptions of the various functions, variables, data structures, and 
so on.

I cannot, of course do that by myself!  I think I can do most of 
/kernel/core and some of /libroot and /libnet.  How do you all feel I 
should proceed with the rest?   I can take the lead in "assigning" 
files to people to be documented.  This would involve contacting the 
leads of the all of the Kit teams on the project.   I can coordinate 
getting the documented files, and generating the html.

Second question:  I'm guessing the /html folders that Doxygen creates 
will NOT be part of the CVS tree?  I don't think it is necessary to do 
that, as we can host the html documentation on the project site.  I can 
be in charge of making sure it is up to date.

Thoughts?

Oh yeah, and here is the online documentation: 
http://216.185.194.22/obos/doxygen/index.html

Brennan