[Kstars-devel] code cleanup tasks

[Jason Harris]

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
Forums: http://kstars.30doradus.org