add jsdoc to mindplot module

--HG--
branch : mindplot_jsdoc
This commit is contained in:
Christina Korger
2015-03-23 09:25:54 +01:00
parent a4da6fb7cd
commit c298732f64
46 changed files with 1524 additions and 108 deletions

View File

@@ -15,8 +15,20 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
mindplot.commands.MoveControlPointCommand = new Class({
mindplot.commands.MoveControlPointCommand = new Class(/** @lends MoveControlPointCommand */{
Extends:mindplot.Command,
/**
* @classdesc This command handles do/undo of changing the control points of a relationship
* arrow. These are the two points that appear when the relationship is on focus. They
* influence how the arrow is drawn (not the source or the destination topic nor the arrow
* direction)
* @constructs
* @param {ControlPoint} ctrlPointController
* @param {Number} point 0 for the destination control point, 1 for the source control point
* @param ctrlPointController {ControlPoint}
* @param point {Number} 0 for the destination control point, 1 for the source control point
*/
initialize:function (ctrlPointController, point) {
$assert(ctrlPointController, 'line can not be null');
$assert($defined(point), 'point can not be null');
@@ -40,6 +52,9 @@ mindplot.commands.MoveControlPointCommand = new Class({
this._point = point;
},
/**
* Overrides abstract parent method
*/
execute:function (commandContext) {
var model = this._line.getModel();
switch (this._point) {
@@ -64,6 +79,10 @@ mindplot.commands.MoveControlPointCommand = new Class({
this._line.getLine().updateLine(this._point);
},
/**
* Overrides abstract parent method
* @see {@link mindplot.Command.undoExecute}
*/
undoExecute:function (commandContext) {
var line = this._line;
var model = line.getModel();