[Kstars-devel] code cleanup tasks

[Jason Harris]

Hi Sean,

Thanks for your interest.  You can follow the directions here to obtain the 
latest code:
http://edu.kde.org/kstars/svn.php

For code cleanup, you will need the trunk code, not the 3.5 branch.  So be 
sure to follow the note in parentheses following step 1.  Also, you won't be 
able to compile the code unless you have the latest development version of 
kdelibs installed, but for most of the cleanup tasks, you don't actually have 
to compile anyway.  So you can skip Step 2.

To transmit your changes to us, just type "svn diff" in the source code 
directory, and send the output to this list.

Have fun, and let us know what you decide to work on.

regards,
Jason

On Tuesday 04 April 2006 19:33, Sean Glazier wrote:
> Hi where can I get te source files etc I would love to take a look and
> clean up the code if you like.
>
> Sean Glazier
>
> Things are really bad when only a fictional character has the right thing
> to say...
> "So this is how liberty dies; to the sound of thunderous applause..."
> --Padme, SW3
>
>
> -----Original Message-----
> From: Jason Harris [mailto:kstars at 30doradus.org]
> Sent: Tuesday, April 04, 2006 8:08 PM
> To: KStars Development Mailing List
> Subject: [Kstars-devel] code cleanup tasks
>
> Hello,
>
> As the codebase approaches stability, I find myself thinking of things I'd
> like to clean up in the code.  Some of these are easy to do, so if you're
> looking for a good way to become familiar with the code, why not take on
> one
>
> or more of these tasks?  To avoid duplication of effort, let us know if you
> plan to do something from this list by replying to this thread.  Also
> reply,
>
> if you think of any more organizational/cleanup tasks.
>
> I've marked the items which require almost no coding knowledge with "JJ:"
>
> Jason
>
> ---------------------------------------------
> Code cleanup tasks for kstars-1.3:
>
> Uniform usage of UI classes (single or double inheritance?)
>
> Find and fix all FIXME and TODO comments
>
> Remove deprecated code
>
> JJ: Remove unnecessary DEBUGs
> JJ: Make sure debug strings have i18n()
>
> Change some int values to enums
>
> JJ: Change all "#include <qfoo.h>" to "#include <QFoo>"
>
> JJ: Make sure #includes in header files are kept to a minimum
>
> Update APIDOX:
>   Make sure all functions are documented
>
>   JJ: Add "@see" where appropriate
>
>   JJ: Use "@param" instead of "@p" ??
>
>   JJ: Make sure @class block comes immediately before class declaration
>
> KDialogBase --> KDialog
>   (*if* we had used KDialogBase::Plain...it's still not clear if the Tabbed
>   version of KDialogBase is going to be deprecated)
>
> Check and update API of each class
>
> JJ: Remove any "const char *name" args from ctors
>
> Pass KStars object pointer arg in ctor instead of casting parent pointer!
>
> JJ: Add "inline" keyword to all inline functions
>
> JJ: Use "const" keyword where you can
>
> JJ: Uniform whitespace and indentation
>
> JJ: Use "m_VariableName" member variable naming scheme

-- 
KStars: http://edu.kde.org/kstars
Community Forums: http://kstars.30doradus.org