Merge pull request #12 from enyojs/ENYO-1526-rs

ENYO-1526 Convert inline docs to modules

Reviewed-By: Ryan Duffy (ryan.duffy@lge.com)
Integrated-By: Ryan Duffy (ryan.duffy@lge.com)

lib/Canvas.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.Canvas} kind.
+* @module canvas/Canvas
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -14,8 +19,10 @@ var
 * canvas.
 *
 * @ui
+* @namespace enyo
 * @class enyo.Canvas
 * @extends enyo.Control
+* @definedby module:canvas/Canvas
 * @public
 */
 module.exports = kind(
@@ -135,4 +142,4 @@ module.exports = kind(
 			this.renderChildren(ctx);
 		}
 	}
-});
+});

lib/CanvasControl.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.CanvasControl} kind.
+* @module canvas/CanvasControl
+*/
+
 var
 	kind = require('enyo/kind'),
 	utils = require('enyo/utils');
@@ -25,8 +30,10 @@ var
 * your drawing code.
 *
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Control
 * @extends enyo.UiComponent
+* @definedby module:canvas/CanvasControl
 * @public
 */
 var CanvasControl = module.exports = kind(
@@ -112,4 +119,4 @@ var CanvasControl = module.exports = kind(
 	}
 });
 
-CanvasControl.prototype.defaultKind = CanvasControl;
+CanvasControl.prototype.defaultKind = CanvasControl;

lib/Circle.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.Circle} kind.
+* @module canvas/Circle
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -9,8 +14,10 @@ var
 * the parameters specified by the [bounds]{@link enyo.canvas.Control#bounds}
 * property on {@link enyo.canvas.Control}. 
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Circle
 * @extends enyo.canvas.Shape
+* @definedby module:canvas/Circle
 * @public
 */
 module.exports = kind(
@@ -34,4 +41,4 @@ module.exports = kind(
 		ctx.arc(this.bounds.l, this.bounds.t, this.bounds.w, 0, Math.PI*2);
 		this.draw(ctx);
 	}
-});
+});

lib/Image.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.Image} kind.
+* @module canvas/Image
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -9,8 +14,10 @@ var
 * to fit the rectangle specified by the [bounds]{@link enyo.canvas.Image#bounds}
 * property.
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Image
 * @extends enyo.canvas.Control
+* @definedby module:canvas/Image
 * @public
 */
 module.exports = kind(
@@ -65,4 +72,4 @@ module.exports = kind(
 	renderSelf: function (ctx) {
 		ctx.drawImage(this.image, this.bounds.l, this.bounds.t);
 	}
-});
+});

lib/Line.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.Line} kind.
+* @module canvas/Line
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -23,8 +28,10 @@ var
 * the parameters specified by the [bounds]{@link enyo.canvas.Line#bounds}
 * property.
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Line
 * @extends enyo.canvas.Shape
+* @definedby module:canvas/Line
 * @public
 */
 module.exports = kind(
@@ -70,4 +77,4 @@ module.exports = kind(
 		ctx.restore();
 	}
 
-});
+});

lib/Rectangle.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.Rectangle} kind.
+* @module canvas/Rectangle
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -9,8 +14,10 @@ var
 * fitting the parameters specified by the [bounds]{@link enyo.canvas.Control#bounds}
 * property.
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Rectangle
 * @extends enyo.canvas.Shape
+* @definedby module:canvas/Rectangle
 * @public
 */
 module.exports = kind(
@@ -65,4 +72,4 @@ module.exports = kind(
 	outline: function (ctx) {
 		ctx.strokeRect(this.bounds.l, this.bounds.t, this.bounds.w, this.bounds.h);
 	}
-});
+});

lib/Shape.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.Shape} kind.
+* @module canvas/Shape
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -15,8 +20,10 @@ var
 * [fill()]{@link enyo.canvas.Shape#fill} method or the
 * [outline()]{@link enyo.canvas.Shape#outline} method, respectively.
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Shape
 * @extends enyo.canvas.Control
+* @definedby module:canvas/Shape
 * @public
 */
 module.exports = kind(
@@ -89,4 +96,4 @@ module.exports = kind(
 			this.outline(context);
 		}
 	}
-});
+});

lib/Text.js

@@ -1,3 +1,8 @@
+/**
+* Contains the declaration for the {@link enyo.canvas.Text} kind.
+* @module canvas/Text
+*/
+
 var
 	kind = require('enyo/kind');
 
@@ -7,8 +12,10 @@ var
 /**
 * {@link enyo.canvas.Text} is a canvas control that draws a text string.
 *
+* @namespace enyo.canvas
 * @class enyo.canvas.Text
 * @extends enyo.canvas.Shape
+* @definedby module:canvas/Text
 * @public
 */
 module.exports = kind(
@@ -80,4 +87,4 @@ module.exports = kind(
 	outline: function (ctx) {
 		ctx.strokeText(this.text, this.bounds.l, this.bounds.t);
 	}
-});
+});