[openbeosstorage] Doxygen vote

I spoke with Michael Phipps today a bit about doxygen. Basically, he
thinks it's a good idea and is going to encourage its use, but isn't going
to require it because he doesn't want to scare people off from the
project who don't want to have to comment their code. As such, it
seems to me fairly unlikely we'll be generating the OpenBeBook from
doxygen comments any day soon. 

I still think doxygen is a great tool, and will be using it for all the classes
 
I write. I've reworked our doxygen=5Fconfig file a bit so we can just use
one /*! comment */ per member and still get a cleaner and more concise
document (see Path.h for an updated example of what I'm going to be doing 
for my classes; I haven't and am not planning on updating the html files in
 CVS,
which I'll remove sometime soon, so you'll have to generate your own).

Since it's not going to be a project-wide requirement, I'm going to leave
it up to general consensus as far as our team is concerned. What do you
guys all want to do=3F Use concise doxygen comments like I've done with
Path.h or not use it at all (or some variant on either theme)=3F

I'm voting for concise doxygen comments.

-Tyler

Other related posts: