diff --git a/lib/OpenLayers/BaseTypes.js b/lib/OpenLayers/BaseTypes.js index 23d78291ab..c470df8253 100644 --- a/lib/OpenLayers/BaseTypes.js +++ b/lib/OpenLayers/BaseTypes.js @@ -16,6 +16,7 @@ /** * APIFunction: String.startsWith + * Whether or not a string starts with another string. * * Parameters: * sStart - {Sring} @@ -29,6 +30,7 @@ String.prototype.startsWith = function(sStart) { /** * APIFunction: String.contains + * Whether or not a string contains another string. * * Parameters: * str - {String} @@ -42,6 +44,7 @@ String.prototype.contains = function(str) { /** * APIMethod: String.trim + * Removes leading and trailing whitespace characters from a string. * * Return: * {String} A trimmed version of the string - all leading and @@ -64,6 +67,7 @@ String.prototype.trim = function() { /** * APIFunction: String.indexOf + * Index of a character in a string. * * Parameters: * object - {Object} Can be a string or a number @@ -79,6 +83,9 @@ String.indexOf = function(object) { /** * APIFunction: camelize + * Camel-case a hyphenated string. + * Ex. "chicken-head" becomes "chickenHead", and + * "-chicken-head" becomes "ChickenHead". * * Return: * {String} The string, camelized @@ -108,7 +115,8 @@ String.prototype.camelize = function() { /** * APIFunction: Number.limitSigDigs - * Works only with integer values does *not* work with floats! + * Limit the number of significant digits on an integer. Does *not* work + * with floats! * * Parameters: * sig - {Integer} @@ -135,6 +143,7 @@ Number.prototype.limitSigDigs = function(sig) { /** * APIFunction: Function.bind + * Bind a function to an object. * * Parameters: * object - {Object} @@ -155,7 +164,9 @@ Function.prototype.bind = function() { /** * APIFunction: Function.bindAsEventListener - * + * Bind a function to an object, and configure it to receive the event object + * as first parameter when called. + * * Parameters: * object - {Object} *