Filling our log with cruft, adding meaningless conflicts for merges, and changing a comment style that ndocs could care less about, this commit changes Return to Returns (closes #945).
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4110 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
@@ -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.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {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.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {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
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<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
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<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.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<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.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<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.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<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.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Geometry>} A geometry.
|
||||
*/
|
||||
"multilinestring": function(array) {
|
||||
@@ -338,7 +338,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Convert a coordinate array from GeoJSON into an
|
||||
* <OpenLayers.Geometry>.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Geometry>} A geometry.
|
||||
*/
|
||||
"polygon": function(array) {
|
||||
@@ -364,7 +364,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* array - {Object} The coordinates array from the GeoJSON fragment.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Geometry>} A geometry.
|
||||
*/
|
||||
"multipolygon": function(array) {
|
||||
@@ -389,7 +389,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* array - {Object} The coordinates array from the GeoJSON fragment.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {<OpenLayers.Geometry>} A geometry.
|
||||
*/
|
||||
"box": function(array) {
|
||||
@@ -420,7 +420,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* pretty - {Boolean} Structure the output with newlines and indentation.
|
||||
* Default is false.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} The GeoJSON string representation of the input geometry,
|
||||
* features, array of geometries, or array of features.
|
||||
*/
|
||||
@@ -494,7 +494,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* feature - {<OpenLayers.Feature.Vector>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} An object representing the point.
|
||||
*/
|
||||
'feature': function(feature) {
|
||||
@@ -514,7 +514,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* geometry - {<OpenLayers.Geometry>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} An object representing the geometry.
|
||||
*/
|
||||
'geometry': function(geometry) {
|
||||
@@ -533,7 +533,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* point - {<OpenLayers.Geometry.Point>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array} An array of coordinates representing the point.
|
||||
*/
|
||||
'point': function(point) {
|
||||
@@ -547,7 +547,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* multipoint - {<OpenLayers.Geometry.MultiPoint>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array} An array of point coordinate arrays representing
|
||||
* the multipoint.
|
||||
*/
|
||||
@@ -566,7 +566,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* linestring - {<OpenLayers.Geometry.LineString>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array} An array of coordinate arrays representing
|
||||
* the linestring.
|
||||
*/
|
||||
@@ -585,7 +585,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* linestring - {<OpenLayers.Geometry.MultiLineString>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array} An array of linestring arrays representing
|
||||
* the multilinestring.
|
||||
*/
|
||||
@@ -604,7 +604,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* polygon - {<OpenLayers.Geometry.Polygon>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array} An array of linear ring arrays representing the polygon.
|
||||
*/
|
||||
'polygon': function(polygon) {
|
||||
@@ -622,7 +622,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
|
||||
* Parameters:
|
||||
* multipolygon - {<OpenLayers.Geometry.MultiPolygon>}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array} An array of polygon arrays representing
|
||||
* the multipolygon
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user