ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

wiki/NaturalDocs says we should be using 'Return:' and not 'Returns:' so this patch is fixing that. Of course, in the process, I came across not a few instances where other ND related whitespace or typos were at odds with a peaceful, uniform OL codebase. No functional changes here, just makin' things pretty.

Browse Source 
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4109 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2007-08-29 18:08:32 +00:00
parent e5641c76e0
commit b5ef77096c
27 changed files with 192 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/OpenLayers/Format/GML.js
+4 -4
View File
@@ -264,7 +264,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {XMLNode}
*
* Returns:
* Return:
* {<OpenLayers.Geometry.Polygon>} polygon geometry
*/
parsePolygonNode: function(polygonNode) {
@@ -291,7 +291,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {<XMLNode>}
*
* Returns:
* Return:
* An array of <OpenLayers.Geometry.Point> points.
*/
parseCoords: function(xmlNode) {
@@ -365,7 +365,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* feature - {<OpenLayers.Feature.Vector>}
*
* Returns:
* Return:
* {DOMElement}
*/
createFeatureXML: function(feature) {
@@ -475,7 +475,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Returns:
* Return:
* {XmlNode} created xmlNode
*/
buildCoordinatesNode: function(geometry) {
lib/OpenLayers/Format/GeoJSON.js
+20 -23
View File
@@ -42,7 +42,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* reform generic objects into instances of classes, or to transform
* date strings into Date objects.
*
* Returns:
* Return:
* {Object} The return depends on the value of the type argument. If type
* is "FeatureCollection" (the default), the return will be an array
* of <OpenLayers.Feature.Vector>. If type is "Geometry", the input json
@@ -147,7 +147,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Method: isValidType
* Check if a GeoJSON object is a valid representative of the given type.
*
* Returns:
* Return:
* {Boolean} The object is valid GeoJSON object of the given type.
*/
isValidType: function(obj, type) {
@@ -188,7 +188,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* obj - {Object} An object created from a GeoJSON object
*
* Returns:
* Return:
* {<OpenLayers.Feature.Vector>} A feature.
*/
parseFeature: function(obj) {
@@ -214,7 +214,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* obj - {Object} An object created from a GeoJSON object
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
parseGeometry: function(obj) {
@@ -248,7 +248,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"point": function(array) {
@@ -266,7 +266,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"multipoint": function(array) {
@@ -291,7 +291,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"linestring": function(array) {
@@ -316,7 +316,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"multilinestring": function(array) {
@@ -338,10 +338,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Convert a coordinate array from GeoJSON into an
* <OpenLayers.Geometry>.
*
* Returns:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"polygon": function(array) {
@@ -367,7 +364,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"multipolygon": function(array) {
@@ -392,7 +389,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} A geometry.
*/
"box": function(array) {
@@ -423,7 +420,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* pretty - {Boolean} Structure the output with newlines and indentation.
* Default is false.
*
* Returns:
* Return:
* {String} The GeoJSON string representation of the input geometry,
* features, array of geometries, or array of features.
*/
@@ -497,7 +494,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* feature - {<OpenLayers.Feature.Vector>}
*
* Returns:
* Return:
* {Object} An object representing the point.
*/
'feature': function(feature) {
@@ -517,7 +514,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Returns:
* Return:
* {Object} An object representing the geometry.
*/
'geometry': function(geometry) {
@@ -536,7 +533,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* point - {<OpenLayers.Geometry.Point>}
*
* Returns:
* Return:
* {Array} An array of coordinates representing the point.
*/
'point': function(point) {
@@ -550,7 +547,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* multipoint - {<OpenLayers.Geometry.MultiPoint>}
*
* Returns:
* Return:
* {Array} An array of point coordinate arrays representing
* the multipoint.
*/
@@ -569,7 +566,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* linestring - {<OpenLayers.Geometry.LineString>}
*
* Returns:
* Return:
* {Array} An array of coordinate arrays representing
* the linestring.
*/
@@ -588,7 +585,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* linestring - {<OpenLayers.Geometry.MultiLineString>}
*
* Returns:
* Return:
* {Array} An array of linestring arrays representing
* the multilinestring.
*/
@@ -607,7 +604,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* polygon - {<OpenLayers.Geometry.Polygon>}
*
* Returns:
* Return:
* {Array} An array of linear ring arrays representing the polygon.
*/
'polygon': function(polygon) {
@@ -625,7 +622,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* multipolygon - {<OpenLayers.Geometry.MultiPolygon>}
*
* Returns:
* Return:
* {Array} An array of polygon arrays representing
* the multipolygon
*/
lib/OpenLayers/Format/GeoRSS.js
+1 -1
View File
@@ -67,7 +67,7 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* feature - {<OpenLayers.Feature.Vector>}
*
* Returns:
* Return:
* {DOMElement}
*/
createFeatureXML: function(feature) {
lib/OpenLayers/Format/JSON.js
+11 -11
View File
@@ -80,7 +80,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* reform generic objects into instances of classes, or to transform
* date strings into Date objects.
*
* Returns:
* Return:
* {Object} An object, array, string, or number .
*/
read: function(json, filter) {
@@ -141,7 +141,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* pretty - {Boolean} Structure the output with newlines and indentation.
* Default is false.
*
* Returns:
* Return:
* {String} The JSON string representation of the input value.
*/
write: function(value, pretty) {
@@ -158,7 +158,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeIndent
* Output an indentation string depending on the indentation level.
*
* Returns:
* Return:
* {String} An appropriate indentation string.
*/
writeIndent: function() {
@@ -175,7 +175,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeNewline
* Output a string representing a newline if in pretty printing mode.
*
* Returns:
* Return:
* {String} A string representing a new line.
*/
writeNewline: function() {
@@ -186,7 +186,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeSpace
* Output a string representing a space if in pretty printing mode.
*
* Returns:
* Return:
* {String} A space.
*/
writeSpace: function() {
@@ -206,7 +206,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* object - {Object} The object to be serialized.
*
* Returns:
* Return:
* {String} A JSON string representing the object.
*/
'object': function(object) {
@@ -255,7 +255,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* array - {Array} The array to be serialized
*
* Returns:
* Return:
* {String} A JSON string representing the array.
*/
'array': function(array) {
@@ -287,7 +287,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters
* string - {String} The string to be serialized
*
* Returns:
* Return:
* {String} A JSON string representing the string.
*/
'string': function(string) {
@@ -326,7 +326,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* number - {Number} The number to be serialized.
*
* Returns:
* Return:
* {String} A JSON string representing the number.
*/
'number': function(number) {
@@ -340,7 +340,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* bool - {Boolean} The boolean to be serialized.
*
* Returns:
* Return:
* {String} A JSON string representing the boolean.
*/
'boolean': function(bool) {
@@ -354,7 +354,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* date - {Date} The date to be serialized.
*
* Returns:
* Return:
* {String} A JSON string representing the date.
*/
'date': function(date) {
lib/OpenLayers/Format/KML.js
+1 -1
View File
@@ -148,7 +148,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {<XMLNode>}
*
* Returns:
* Return:
* An array of <OpenLayers.Geometry.Point> points.
*/
parseCoords: function(xmlNode) {
lib/OpenLayers/Format/XML.js
+8 -8
View File
@@ -53,7 +53,7 @@ OpenLayers.Format.XML.prototype =
* Parameters:
* text - {String} A XML string
* Returns:
* Return:
* {DOMElement} A DOM node
*/
read: function(text) {
@@ -101,7 +101,7 @@ OpenLayers.Format.XML.prototype =
* Parameters:
* node - {DOMElement} A DOM node.
*
* Returns:
* Return:
* {String} The XML string representation of the input node.
*/
write: function(node) {
@@ -126,7 +126,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI for the element.
* name - {String} The qualified name of the element (prefix:localname).
*
* Returns:
* Return:
* {Element} A DOM element with namespace.
*/
createElementNS: function(uri, name) {
@@ -148,7 +148,7 @@ OpenLayers.Format.XML.prototype =
* Parameters:
* text - {String} The text of the node.
*
* Returns:
* Return:
* {DOMElement} A DOM text node.
*/
createTextNode: function(text) {
@@ -173,7 +173,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the tag (without the prefix).
*
* Returns:
* Return:
* {NodeList} A node list or array of elements.
*/
getElementsByTagNameNS: function(node, uri, name) {
@@ -207,7 +207,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix).
*
* Returns:
* Return:
* {DOMElement} An attribute node or null if none found.
*/
getAttributeNodeNS: function(node, uri, name) {
@@ -241,7 +241,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix).
*
* Returns:
* Return:
* {String} An attribute value or and empty string if none found.
*/
getAttributeNS: function(node, uri, name) {
@@ -267,7 +267,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix).
*
* Returns:
* Return:
* {Boolean} The node has an attribute matching the name and namespace.
*/
hasAttributeNS: function(node, uri, name) {