FreeLists / openbeosstorage / [openbeosstorage] Development Guidelines

["Tyler Dauwalder" <tyler@xxxxxxxxxxxxx>]

Okay, it looks to me like we'll start some degree of
coding here shortly (I'm putting together a development 
cycle proposal I'll post to the list shortly), so here's the 
run down on the development guidelines we're supposed 
to follow (I'll get all the code I've submitted so far polished 
up to par in the next couple of days):

+ OpenTracker coding style
+ Doxygen style documentation comments
+ Go for binary compatibility per Erik's Newsletter article
+ Jam for build management
+ Write accompanying unit tests where feasible (i.e. non-GUI)

------------------------------------------------------------
Open Tracker Coding Style:
------------------------------------------------------------
This actually isn't too bad in my opinion. I hate doing
curly braces that way, but I'll get over it. Try and follow
it as much as you can, I guess. :-)

http://opentracker.sourceforge.net/guidelines.html


------------------------------------------------------------
Doxygen Style Documentation Comments:
------------------------------------------------------------
I think this is a really good idea. I have to admit to 
never having actually used it, but looking through the
tutorials it looks to me like a good system. 

The theory of this is that all the teams will use 
Doxygen style comments, and eventually, with a
little tweaking and possibly a special team to write
up some custom tools, the BeBook will be generable
entirely from source documentation.

The reality at the moment is that no one's doing it. 
Somebody has to start it up, so it might as well be
us :-). I'm hoping to get the ball rolling a little faster
at the next admin meeting as to project-wide use.

There appears to be a Doxygen binary on BeBits,
so I'm going to try to get that up and running on my 
machine. Have any of you ever used Doxygen (or 
JavaDoc)?

http://www.stack.nl/~dimitri/doxygen/
http://www.bebits.com/app/1643

 
------------------------------------------------------------
Go for binary compatibility per Erik's Newsletter article

------------------------------------------------------------

This shouldn't be too tough...I hope. :-)

http://open-beos.sourceforge.net/nsl/nsl-11.php


------------------------------------------------------------
Jam for build management
------------------------------------------------------------

I don't know much about it, and haven't tried installing it
yet. It sounds like it'll be fine, though. It's going to be used
system-wide once Ithamar gets on top of things.


------------------------------------------------------------
Write accompanying unit tests where feasible (i.e. non-GUI)
------------------------------------------------------------

CppUnit for us, in theory. How's that going, Simon 
and/or Keith?


-Tyler