properly declare CLASS_NAME member as constant. Also, add <i> tags around examples in comments

git-svn-id: http://svn.openlayers.org/trunk/openlayers@105 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2006-05-17 17:11:32 +00:00
parent ff2e3017f9
commit 9235f04cce
4 changed files with 16 additions and 14 deletions
+1 -1
View File
@@ -35,6 +35,6 @@ OpenLayers.Control.prototype = {
this.map = null; this.map = null;
}, },
/** @type String */ /** @final @type String */
CLASS_NAME: "OpenLayers.Control" CLASS_NAME: "OpenLayers.Control"
}; };
+1 -1
View File
@@ -135,7 +135,7 @@ OpenLayers.Control.LayerSwitcher.prototype =
}, },
/** @type String */ /** @final @type String */
CLASS_NAME: "OpenLayers.Control.LayerSwitcher" CLASS_NAME: "OpenLayers.Control.LayerSwitcher"
}); });
+1
View File
@@ -50,6 +50,7 @@ OpenLayers.Tile.prototype = {
remove:function() { remove:function() {
}, },
/** @final @type String */
CLASS_NAME: "OpenLayers.Tile" CLASS_NAME: "OpenLayers.Tile"
}; };
+13 -12
View File
@@ -88,7 +88,7 @@ OpenLayers.Pixel.prototype = {
return new OpenLayers.Pixel(this.x + x, this.y + y); return new OpenLayers.Pixel(this.x + x, this.y + y);
}, },
/** @type str */ /** @final @type str */
CLASS_NAME: "OpenLayers.Pixel" CLASS_NAME: "OpenLayers.Pixel"
}; };
@@ -117,7 +117,7 @@ OpenLayers.Size.prototype = {
/** /**
* @return String representation of OpenLayers.Size object. * @return String representation of OpenLayers.Size object.
* (ex. "w=55,h=66") * (ex. <i>"w=55,h=66"</i>)
* @type String * @type String
*/ */
toString:function() { toString:function() {
@@ -143,7 +143,7 @@ OpenLayers.Size.prototype = {
return ((this.w == sz.w) && (this.h == sz.h)); return ((this.w == sz.w) && (this.h == sz.h));
}, },
/** @type String */ /** @final @type String */
CLASS_NAME: "OpenLayers.Size" CLASS_NAME: "OpenLayers.Size"
}; };
@@ -172,7 +172,7 @@ OpenLayers.LonLat.prototype = {
/** /**
* @return String representation of OpenLayers.LonLat object. * @return String representation of OpenLayers.LonLat object.
* (ex. "lon=5,lat=42") * (ex. <i>"lon=5,lat=42"</i>)
* @type String * @type String
*/ */
toString:function() { toString:function() {
@@ -181,7 +181,7 @@ OpenLayers.LonLat.prototype = {
/** /**
* @return Shortened String representation of OpenLayers.LonLat object. * @return Shortened String representation of OpenLayers.LonLat object.
* (ex. "5,42") * (ex. <i>"5,42"</i>)
* @type String * @type String
*/ */
toShortString:function() { toShortString:function() {
@@ -217,7 +217,7 @@ OpenLayers.LonLat.prototype = {
return ((this.lon == ll.lon) && (this.lat == ll.lat)); return ((this.lon == ll.lon) && (this.lat == ll.lat));
}, },
/** @type String */ /** @final @type String */
CLASS_NAME: "OpenLayers.LonLat" CLASS_NAME: "OpenLayers.LonLat"
}; };
@@ -226,7 +226,8 @@ OpenLayers.LonLat.prototype = {
* *
* @constructor * @constructor
* *
* @param {String} str Comma-separated Lon,Lat coordinate string. (ex. "5,40") * @param {String} str Comma-separated Lon,Lat coordinate string.
* (ex. <i>"5,40"</i>)
* *
* @returns New OpenLayers.LonLat object built from the passed-in String. * @returns New OpenLayers.LonLat object built from the passed-in String.
* @type OpenLayers.LonLat * @type OpenLayers.LonLat
@@ -284,13 +285,13 @@ OpenLayers.Bounds.prototype = {
/** /**
* @return String representation of OpenLayers.Bounds object. * @return String representation of OpenLayers.Bounds object.
* (ex. "Min lon/lat=5/42 Max lon/lat=10/45 width:5 height:3") * (ex.<i>"Min lon/lat=5/42 Max lon/lat=10/45 width=5 height=3"</i>)
* @type String * @type String
*/ */
toString:function(){ toString:function(){
return ("Min lon/lat=" + this.minlon +"/"+ this.minlat return ("Min lon/lat=" + this.minlon +"/"+ this.minlat
+ " Max lon/lat=" + this.maxlon +"/"+ this.maxlat + " Max lon/lat=" + this.maxlon +"/"+ this.maxlat
+ " width:" + this.width + " height:" + this.height); + " width=" + this.width + " height=" + this.height);
}, },
/** /**
@@ -304,7 +305,7 @@ OpenLayers.Bounds.prototype = {
/** /**
* @return Simple String representation of OpenLayers.Bounds object. * @return Simple String representation of OpenLayers.Bounds object.
* (ex. "5,42,10,45") * (ex. <i>"5,42,10,45"</i>)
* @type String * @type String
*/ */
toBBOX:function(){ toBBOX:function(){
@@ -323,7 +324,7 @@ OpenLayers.Bounds.prototype = {
&& (ll.lat >= this.minlat) && (ll.lat <= this.maxlat)); && (ll.lat >= this.minlat) && (ll.lat <= this.maxlat));
}, },
/** @type String */ /** @final @type String */
CLASS_NAME: "OpenLayers.Bounds" CLASS_NAME: "OpenLayers.Bounds"
}; };
@@ -332,7 +333,7 @@ OpenLayers.Bounds.prototype = {
* *
* @constructor * @constructor
* *
* @param {String} str Comma-separated bounds string. (ex. "5,42,10,45") * @param {String} str Comma-separated bounds string. (ex. <i>"5,42,10,45"</i>)
* *
* @returns New OpenLayers.Bounds object built from the passed-in String. * @returns New OpenLayers.Bounds object built from the passed-in String.
* @type OpenLayers.Bounds * @type OpenLayers.Bounds