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.

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

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) {