Code needs to be commented

[sguergachi]

We need to add comments to code following this: http://antjanus.com/blog/web-design-tips/best-comment-separator/

[sguergachi]

Ok, so here is the multi line comment wrapper I think we should use. Simple title, max of 2 paragraphs to be used for main methods. Just copy and paste, the spaces have been put in place so editing shouldn't be necessary.

/**
* .------------------------------------------------------------------------.
* |    
* .------------------------------------------------------------------------.
* |
* | 
* | 
* | 
* |
* | 
* | 
* | 
* | 
* |
* |
* |
* .........................................................................
*
* @
*
 */

Here is an example of what it should look like:

/**
* .------------------------------------------------------------------------.
* |    DashboardUI :: Aurora Screen Class
* .------------------------------------------------------------------------.
* |
* | This class contains the UI attached to an appropriate *Handler*
* | and *Logic* class which handle the actions caused by the UI
* | components found here
* |
* | This class must follow the rules stated in the AuroraScreenUI
* | Interface. The *Handler* and *Logic* classes
* | The Handler class is called: DashboardHandler
* | The Logic class is called: DashboardLogic
* |
* |
* |
* .........................................................................
*
* @author sammy <sguergachi@gmail.com> carlos <>
*
 */


/**
* .------------------------------------------------------------------------.
* |    DashboardUI()
* .------------------------------------------------------------------------.
* |
* | This is the Constructor of the Dashboard UI class
* |
* | The Constructor of Screen Classes must initialize/create both a
* | Handler and a Logic object which should contain the UI as a parameter
* |
* ..........................................................................
*
* @param auroraCoreUI AuroraCoreUI
* @param startScreenUI StartScreenUI
*
*/

let me know if you like it.

[sguergachi]

Dealing with long lines.

Notice what is placed first in each line, notice the space after the comma, plus or whatever.

- Has commas:

BEFORE:

btnLogout = new aButton("Aurora_Logout_normal.png", "Aurora_Logout_down.png", "Aurora_Logout_over.png", SIZE_btnLogoutWidth, SIZE_btnLogoutHeight);

AFTER:

    btnLogout = new aButton("Aurora_Logout_normal.png"
            , "Aurora_Logout_down.png"
            , "Aurora_Logout_over.png"
            , SIZE_btnLogoutWidth
            , SIZE_btnLogoutHeight);

- Has commas and other stuff:

BEFORE:

coreUI.getPnlTop().setPreferredSize(new Dimension(coreUI.getPnlTop().getWidth(),coreUI.getPnlTop().getImageHeight()+coreUI.getPnlFrameControl().getHeight()));

AFTER:

    coreUI.getPnlTop().setPreferredSize(
            new Dimension(coreUI.getPnlTop().getWidth()
            , coreUI.getPnlTop().getImageHeight()
            + coreUI.getPnlFrameControl().getHeight()));

- Long If Statments:

BEFORE:

if (storage.getStoredLibrary().getBoxArtPath() == null || storage.getStoredLibrary().getBoxArtPath().isEmpty()) {.

AFTER:

    if (storage.getStoredLibrary().getBoxArtPath() == null
            || storage.getStoredLibrary().getBoxArtPath().isEmpty()) {

[sguergachi]

Closing this, comment code you edit or create, overtime we will comment the rest of the codebase