FreeLists / openbeostranslationkit / [openbeostranslationkit] Beautification Topics

["Travis Smith" <sage@xxxxxxxx>]

Yeah - it's a bit better than mine, but I never professed at being good
with UI. There's a reason I'm not working on the CDT.

I will admit I wasn't expecting Michael to post the 'whole' email. I can
live with that though, it got the job done.

Beautification
doxygen - I know nothing of. I've never used it, but I will look for
something to forward to everyone. It's what the documentation will be
based upon, so it is wisest to use it. 

Coding guidelines - http://opentracker.sourceforge.net/guidelines.html
it is what the project agreed to use, so we're using them. They aren't
too hard to follow. I will admit that it takes a while to use 'other'
guide lines when you are used to your own. 

So if we all take time and make our code beautiful we all can be
happier. 

I'll work on the progress plan consistency. 

As to CVS: Mike and Brian - I'll get you added for access. I'll let you
know when that's working. Also, try to start using JAM
(http://www.perforce.com/jam/jam.html).

-------------
~Travis Smith
sage at ieee dot org 

-----Original Message-----
From: openbeostranslationkit-bounce@xxxxxxxxxxxxx
[mailto:openbeostranslationkit-bounce@xxxxxxxxxxxxx] On Behalf Of Brian
Matzon
Sent: Tuesday, April 02, 2002 12:39 PM
To: openbeostranslationkit@xxxxxxxxxxxxx
Subject: [openbeostranslationkit] Re: go a head and send me the edited
html (fwd)

----- Original Message ----- 
From: "Mike Wilber" <wilber@xxxxxxxxxxxxxxxx>
> This got sent to me, I don't know how they found me, but here this is.
heh - that should have been for Travis it seems :)
Seems a tad better that Travis' version ;P

As we're on the topic of beautification.
1. Our source code is really inconsistent. We need to beautify it.
    - we need to use the same header - preferably something along 
       that of BTranslatorRosterTest.cpp which I got from some 
       plugin (can't remember where).
    - we need to use doxygen tags (tutorial/faq anywhere?)
    - we need to comment using opentracker guiding lines...
    - Genereally I think we all break(coding guidelines) some 
       stuff here and there, but we really should aim for consistency.

2. The progress plan need to be consistent. Currently BBitmapStream
    has all its methods marked as need testing while BTranslatorRoster
   doesn't. Either we expand all of them or we don't. I vote for not 
   expanding them...

I realize that this is not particularly relevant right now, given that
we have 
other things to do. But at least now we've gotten it on the table..

/Brian Matzon