dojox/drawing: Fix api doc formatting, in particular moving class level summary/description of oo.declare() classes into prototype section, so the doc parser will pick them up. Refs #13101 !strict.

Author: wkeese

drawing/Drawing.js

@@ -13,7 +13,7 @@ function(dojo, defaults, registry, keys, Mouse, Canvas, Undo, Anchors, Stencil,
 		//		a Dijit to keep the file size light. But if Dijit is available, Drawing
 		//		will register itself with it and can be accessed dijit.byId('myDrawing')
 		//
-		//	NOTES:
+		//		NOTES:
 		//		Although not Drawing and Toolbar, all other objects are created with a custom
 		//		declare. See dojox.drawing.util.oo
 		//
@@ -68,7 +68,7 @@ function(dojo, defaults, registry, keys, Mouse, Canvas, Undo, Anchors, Stencil,
 		//		|		plugins="[{'name':'dojox.drawing.plugins.drawing.Grid', 'options':{gap:100}}]">
 		//		|   </div>
 		//
-		//	example:
+		// example:
 		//		|	<div dojoType="dojox.drawing.Toolbar" drawingId="drawing" class="drawingToolbar vertical">
 		//		|		<div tool="dojox.drawing.tools.Line" selected="false">Line</div>
 		//		|		<div tool="dojox.drawing.tools.Rect" selected="false">Rect</div>
@@ -105,7 +105,7 @@ function(dojo, defaults, registry, keys, Mouse, Canvas, Undo, Anchors, Stencil,
 			// summary:
 			//		Drawing is not a Dijit. This is the master method.
 			//		NOTE:
-			// 			props is always null since this is not a real widget
+			//			props is always null since this is not a real widget
 			//			Will change when Drawing can be created programmatically.
 
 			var def = dojo.attr(node, "defaults");
@@ -205,7 +205,7 @@ function(dojo, defaults, registry, keys, Mouse, Canvas, Undo, Anchors, Stencil,
 
 		getShapeProps: function(/* Object */data, mode){
 			// summary:
-			// 		The common objects that are mixed into
+			//		The common objects that are mixed into
 			//		a new Stencil. Mostly internal, but could be used.
 
 			var surface = data.stencilType;
@@ -233,8 +233,8 @@ function(dojo, defaults, registry, keys, Mouse, Canvas, Undo, Anchors, Stencil,
 
 		initPlugins: function(){
 			// summary:
-			// 		Called from Toolbar after a plugin has been loaded
-			// 		The call to this coming from toobar is a bit funky as the timing
+			//		Called from Toolbar after a plugin has been loaded
+			//		The call to this coming from toobar is a bit funky as the timing
 			//		of IE for canvas load is different than other browsers
 			if(!this.canvas || !this.canvas.surfaceReady){
 				var c = dojo.connect(this, "onSurfaceReady", this, function(){
@@ -415,7 +415,7 @@ function(dojo, defaults, registry, keys, Mouse, Canvas, Undo, Anchors, Stencil,
 		changeDefaults: function(/*Object*/newStyle,/*Boolean*/value){
 			// summary:
 			//		Change the defaults so that all Stencils from this
-			// 		point on will use the newly changed style.
+			//		point on will use the newly changed style.
 			// newStyle: Object
 			//		An object that represents one of the objects in
 			//		drawing.style that will be mixed in. Not all

drawing/annotations/Angle.js

@@ -1,19 +1,8 @@
 define(["dojo", "../util/oo", "../util/positioning"], 
 function(dojo, oo, positioning){
 
-// summary:
-//		When initiated, an HTML box will hover near the Stencil,
-//		displaying it's angle while drawn or modified. Currently
-//		only works with Vector, Line, Arrow, and Axes.
-// description:
-//		Annotation is positioned with dojox.drawing.util.positioning.angle
-//		That method should be overwritten for custom placement.
-//		Called internally.
-
 //dojox.drawing.annotations.Angle = 
 return oo.declare(
-	//	TODO: currently always on
-
 	function(/*Object*/ options){
 		// options: Object
 		//		One key value: the stencil that called this.
@@ -31,6 +20,15 @@ return oo.declare(
 		]);
 	},
 	{
+		// summary:
+		//		When initiated, an HTML box will hover near the Stencil,
+		//		displaying it's angle while drawn or modified. Currently
+		//		only works with Vector, Line, Arrow, and Axes.
+		// description:
+		//		Annotation is positioned with dojox.drawing.util.positioning.angle
+		//		That method should be overwritten for custom placement.
+		//		Called internally.
+
 		type:"dojox.drawing.tools.custom",
 		angle:0,
 
@@ -75,7 +73,7 @@ return oo.declare(
 		},
 
 		getAngleNode: function(){
-			//	summary:
+			// summary:
 			//		Gets or creates HTMLNode used for display
 			if(!this._angleNode){
 				this._angleNode = dojo.create("span", null, dojo.body());
@@ -86,7 +84,7 @@ return oo.declare(
 		},
 
 		hideAngle: function(){
-			//	summary:
+			// summary:
 			//		Turns display off.
 
 			if(this._angleNode && dojo.style(this._angleNode, "opacity")>0.9){
@@ -102,6 +100,5 @@ return oo.declare(
 
 		}
 	}
-
 );
 });

drawing/annotations/Arrow.js

@@ -1,13 +1,7 @@
 define(["../util/oo", "../stencil/Path"], 
 function(oo, Path){
 
-// summary:
-//		An annotation called internally to put an arrowhead
-//		on ether end of a Line. Initiated in Arrow (and Vector)
-//		with the optional params: arrowStart and arrowEnd. Both
-//		default true for Axes.
-
-//dojox.drawing.annotations.Arrow = 
+//dojox.drawing.annotations.Arrow =
 return oo.declare(
 
 	Path,
@@ -31,6 +25,12 @@ return oo.declare(
 
 	},
 	{
+		// summary:
+		//		An annotation called internally to put an arrowhead
+		//		on ether end of a Line. Initiated in Arrow (and Vector)
+		//		with the optional params: arrowStart and arrowEnd. Both
+		//		default true for Axes.
+
 		idx1:0,
 		idx2:1,
 

drawing/annotations/BoxShadow.js

@@ -1,19 +1,6 @@
 define(["dojo", "dojo/_base/Color", "../util/oo"], 
 function(dojo, Color, oo){
 
-// summary:
-//		Creates a box shadow under solid objects. Can change the
-//		shadow direction, color, size, and intensity. Can center
-//		the shadow and make it a Glow.
-// description:
-//		This is a pseudo shadow, created by duplicating the
-//		original stencil and increasing the line weight while
-//		reducing the opacity. Therefore it will not work with
-//		text. Also won't look very good if the Stencil has no
-//		fill or is transparent. Can't do knockouts or inner
-//		shadows. Currently can't do paths - while doable, it
-//		will most likely choke IE into certain death.
-
 return oo.declare(
 	function(/*Object*/options){
 		this.stencil = options.stencil;
@@ -32,7 +19,7 @@ return oo.declare(
 			//		lineWidths that overlap to make the shadow. Generally you want a
 			//		bigger 'size' than 'mult'. The defaults are good for a shadow, but
 			//		you will want to increase them when making a glow.
-			//	TODO: Make this more clear or use other properties.
+			//		TODO: Make this more clear or use other properties.
 			size:6,
 
 			// mult: Number
@@ -41,7 +28,7 @@ return oo.declare(
 			//		lineWidths that overlap to make the shadow. Generally you want a
 			//		bigger 'size' than 'mult'. The defaults are good for a shadow, but
 			//		you will want to increase them when making a glow.
-			//	TODO: Make this more clear or use other properties.
+			//		TODO: Make this more clear or use other properties.
 			mult:4,
 
 			// alpha: Float
@@ -50,7 +37,7 @@ return oo.declare(
 			//		dark and . is black. Higher numbers also give a sharper edge.
 			alpha:.05,
 
-			//	place: String
+			// place: String
 			//		Tells the position of the shadow:
 			//			B: bottom
 			//			T: top
@@ -61,10 +48,10 @@ return oo.declare(
 			//		be used by itself.
 			place:"BR",
 
-			//	color: String
+			// color: String
 			//		The color of the shadow or glow.
 			color:"#646464"
-		}
+		};
 
 		delete options.stencil;
 		this.options = dojo.mixin(shadowDefaults, options);
@@ -98,6 +85,19 @@ return oo.declare(
 		}
 	},
 	{
+		// summary:
+		//		Creates a box shadow under solid objects. Can change the
+		//		shadow direction, color, size, and intensity. Can center
+		//		the shadow and make it a Glow.
+		// description:
+		//		This is a pseudo shadow, created by duplicating the
+		//		original stencil and increasing the line weight while
+		//		reducing the opacity. Therefore it will not work with
+		//		text. Also won't look very good if the Stencil has no
+		//		fill or is transparent. Can't do knockouts or inner
+		//		shadows. Currently can't do paths - while doable, it
+		//		will most likely choke IE into certain death.
+
 		showing:true,
 		render: function(){
 			if(this.container){

drawing/annotations/Label.js

@@ -4,13 +4,6 @@ function(exports, lang, oo, Text){
 // TODO: why not just return Label?
 
 exports.Label = oo.declare(
-	// summary:
-	//		An annotation called internally to label an Stencil.
-	// description:
-	//		Annotation is positioned with dojox.drawing.util.positioning.label
-	//		That method should be overwritten for custom placement. Or,
-	//		add a 'setLabelCustom' method to the Stencil and it will be used.
-
 	Text,
 	function(/*Object*/options){
 		// options: Object
@@ -29,6 +22,13 @@ exports.Label = oo.declare(
 			this.connect(this.master, "attr", this, "beforeAttr");
 		}
 	},{
+		// summary:
+		//		An annotation called internally to label an Stencil.
+		// description:
+		//		Annotation is positioned with dojox.drawing.util.positioning.label
+		//		That method should be overwritten for custom placement. Or,
+		//		add a 'setLabelCustom' method to the Stencil and it will be used.
+
 		_align:"start",
 		drawingType:"label",
 

drawing/defaults.js

@@ -29,29 +29,29 @@ define({
 	currentHit:null,
 
 	// angleSnap: Number
-	// 		Line, arrows, vector and axes will all snap to this angle on mouse up
-	// 		shown angle also reflects the snap
-	// 		currently cannot accept less than 1 degree
+	//		Line, arrows, vector and axes will all snap to this angle on mouse up
+	//		shown angle also reflects the snap
+	//		currently cannot accept less than 1 degree
 	angleSnap:1,
 
 	// zAxis:  Boolean
-    // 		If true, draw current object in z-direction.
+    //		If true, draw current object in z-direction.
 	// zAxisEnabled: Boolean
-    // 		If true, render axes with Z-axis included, allow objects drawn in z-direction.
+    //		If true, render axes with Z-axis included, allow objects drawn in z-direction.
 	//		If false the z-axis button will not show up.
 	zAxis: false,
 	zAxisEnabled: true,
 	zAngle: 225,
 
 	// renderHitLines: Boolean
 	//		If true, renders a second, larger layer for lines to make
-	// 		them more easily clickable.
+	//		them more easily clickable.
 	renderHitLines: true,
 
 	// renderHitLayer:
-	// 		If true, renders a second layer for each Stencil, one
-	// 		acting as a 'hit' object for a wider mouse-click area.
-	// 		It also doubles as a hilight. If true, overrides
+	//		If true, renders a second layer for each Stencil, one
+	//		acting as a 'hit' object for a wider mouse-click area.
+	//		It also doubles as a hilight. If true, overrides
 	//		renderHitLines setting.
 	renderHitLayer:true,
 
@@ -64,9 +64,9 @@ define({
 
 	norm:{
 		// summary:
-		// 		Normal style of all shapes
-		// 		will get overridden by
-		// 		above andes styles
+		//		Normal style of all shapes
+		//		will get overridden by
+		//		above andes styles
 		width:1,
 		color:"#000000",
 		style:"Solid",
@@ -76,17 +76,17 @@ define({
 
 	selected:{
 		// summary:
-		// 		Selected style of all shapes
-		// 		styles not shown will used from
+		//		Selected style of all shapes
+		//		styles not shown will used from
 		//	norm
 		width:6,
 		color:"#00FF00"
 	},
 
 	highlighted:{
 		// summary:
-		// 		Highlighted style of all shapes
-		// 		NOT CURRENTLY BEING USED
+		//		Highlighted style of all shapes
+		//		NOT CURRENTLY BEING USED
 		width:6,
 		color:"#FF00FF",
 		style:"Solid",
@@ -96,7 +96,7 @@ define({
 
 	disabled:{
 		// summary:
-		// 		Disabled or "locked" or "fade" style of all shapes
+		//		Disabled or "locked" or "fade" style of all shapes
 		width:1,
 		color:"#666666",
 		style:"solid",
@@ -139,7 +139,7 @@ define({
 
 	anchors:{
 		// summary:
-		// 		Style for the anchor resize-points
+		//		Style for the anchor resize-points
 		size:10,
 		width:2,
 		color:"#999",
@@ -151,16 +151,16 @@ define({
 	},
 	arrows:{
 		// summary:
-		// 		Size of arrows on vectors.
-		// 		length is in pixels
-		// 		width is actually an angle
-		// 		but is close to pixels in size
+		//		Size of arrows on vectors.
+		//		length is in pixels
+		//		width is actually an angle
+		//		but is close to pixels in size
 		length:30,
 		width:16
 	},
 	text:{
 		// summary:
-		// 		Style of text
+		//		Style of text
 		minWidth:100,
 		deleteEmptyCreate:true,
 		deleteEmptyModify:true,
@@ -172,7 +172,7 @@ define({
 	},
 	textDisabled:{
 		// summary:
-		// 		Style of disabled text
+		//		Style of disabled text
 		size:"18px",
 		family:"sans-serif",
 		weight:"normal",
@@ -181,7 +181,7 @@ define({
 
 	textMode:{
 		// summary:
-		// 		These styles apply to the containing
+		//		These styles apply to the containing
 		//		text box (edit mode), and not the text itself
 		create:{
 			width:2,
@@ -250,7 +250,7 @@ define({
 		// summary:
 		//		Each shape gets its own copy
 		//		of these styles so that instances
-		// 		do not change each other's styles
+		//		do not change each other's styles
 
 		var cpy = function(obj){
 				if(typeof(obj)!="object" || obj===null || obj===undefined){