[orbitcpp-list] Documenting ORBitcpp for Orbit2 developers

[<bb...@ya...>]

If there is serious interest (ORBit-2) that is going to bring new
development to this project then it is probably important that things
are properly documented. This would reduce the initial learning
overhead of new developers joining the effort.

I started investigating inserting doxygen (javaDoc-style) doc blocks
into ORBitcpp code a while ago. Doxygen (at www.doxygen.org), if you
haven't used it, is an excellent and very flexible code documentation
tool.

I'm in the process of putting together general comment block
templates for functions, classes, files etc. If this would be useful
to anyone at this point let me know and I'll make an effort to get
something out there soon - and send patches for some of the doc I've
been working on.

--

Rich


http://shopping.yahoo.com.au - Yahoo! Shopping
- Free CDs for thousands of Priority Shoppers!