jsDoc_readme

######## installation ##########
prerequisites:
*java runtime installed (including environment variables)
*ksh interpreter installed (e.g. linux --> apt-get install ksh)

1) download jsdoc-toolkit --> https://code.google.com/p/jsdoc-toolkit/downloads/list

2) extract .zip file

3) make "jsrun.jar" and "jsrun.sh" executable (e.g. linux --> chmod a+x)

4) create output directory (e.g. $HOME/doc)

5) run "jsrun.sh" (e.g. linux in same directory ./jsrun.sh) with parameters
e.g. --> ./jsrun.sh -t=/home/markus/local/jsdoc-toolkit/templates/jsdoc -d=$HOME/doc -r $HOME/git/HTML5-git/Client/pocketCode/scripts

6) documentation will be created in $HOME/doc

7) template can be altered/changed in ../jsdoc-toolkit/templates


######## best practice ##########
see sprite.js

used annotations:
@fileOverview : at the beginning of the file, describes what the file contains
@author : at the beginning of the file, usually "catrobat HTML5 team"
@namespace : defining namespaces
@type : above enumerations, describes which types are possible
@class : above class, describes what class is for (e.g. @class Sprite whole functionality of a sprite object)
@property : above class, describes the property of the class. Use {} for the type of the property
            (e.g.  @property {number} id indicates the id of the sprite)
@param : above method, describes the input parameter of the mehtod
@constructor : above constructor, describes special initialization and method calls
@event : above event (on-".."), describes what the event does
            (e.g. @event indicates whether the sprite finished execution onExecuted
@private : above private method (_...), describes what the method does
@returns : above method, describes what the method returns
@throws : above method, describes when an error is thrown