A few doc tweaks for BaseTypes (see #983).
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4350 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
+11
-11
@@ -16,7 +16,7 @@
|
|||||||
OpenLayers.String = {
|
OpenLayers.String = {
|
||||||
/**
|
/**
|
||||||
* APIMethod: OpenLayers.String.startsWith
|
* APIMethod: OpenLayers.String.startsWith
|
||||||
* Whether or not a string starts with another string.
|
* Test whether a string starts with another string.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* str - {String} The string to test.
|
* str - {String} The string to test.
|
||||||
@@ -31,7 +31,7 @@ OpenLayers.String = {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* APIMethod: OpenLayers.String.contains
|
* APIMethod: OpenLayers.String.contains
|
||||||
* Whether or not a string contains another string.
|
* Test whether a string contains another string.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* str - {String} The string to test.
|
* str - {String} The string to test.
|
||||||
@@ -53,7 +53,7 @@ OpenLayers.String = {
|
|||||||
* modified.
|
* modified.
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* {String} A trimmed version of the string - all leading and
|
* {String} A trimmed version of the string with all leading and
|
||||||
* trailing spaces removed.
|
* trailing spaces removed.
|
||||||
*/
|
*/
|
||||||
trim: function(str) {
|
trim: function(str) {
|
||||||
@@ -86,7 +86,7 @@ OpenLayers.String = {
|
|||||||
if (!String.prototype.startsWith) {
|
if (!String.prototype.startsWith) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: String.startsWith
|
* APIMethod: String.startsWith
|
||||||
* Deprecated. Whether or not a string starts with another string.
|
* *Deprecated*. Whether or not a string starts with another string.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* sStart - {Sring} The string we're testing for.
|
* sStart - {Sring} The string we're testing for.
|
||||||
@@ -106,7 +106,7 @@ if (!String.prototype.startsWith) {
|
|||||||
if (!String.prototype.contains) {
|
if (!String.prototype.contains) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: String.contains
|
* APIMethod: String.contains
|
||||||
* Deprecated. Whether or not a string contains another string.
|
* *Deprecated*. Whether or not a string contains another string.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
* str - {String} The string that we're testing for.
|
* str - {String} The string that we're testing for.
|
||||||
@@ -126,7 +126,7 @@ if (!String.prototype.contains) {
|
|||||||
if (!String.prototype.trim) {
|
if (!String.prototype.trim) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: String.trim
|
* APIMethod: String.trim
|
||||||
* Deprecated. Removes leading and trailing whitespace characters from a string.
|
* *Deprecated*. Removes leading and trailing whitespace characters from a string.
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
* {String} A trimmed version of the string - all leading and
|
* {String} A trimmed version of the string - all leading and
|
||||||
@@ -143,8 +143,8 @@ if (!String.prototype.trim) {
|
|||||||
|
|
||||||
if (!String.prototype.camelize) {
|
if (!String.prototype.camelize) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: camelize
|
* APIMethod: String.camelize
|
||||||
* Deprecated. Camel-case a hyphenated string.
|
* *Deprecated*. Camel-case a hyphenated string.
|
||||||
* Ex. "chicken-head" becomes "chickenHead", and
|
* Ex. "chicken-head" becomes "chickenHead", and
|
||||||
* "-chicken-head" becomes "ChickenHead".
|
* "-chicken-head" becomes "ChickenHead".
|
||||||
*
|
*
|
||||||
@@ -193,7 +193,7 @@ OpenLayers.Number = {
|
|||||||
if (!Number.prototype.limitSigDigs) {
|
if (!Number.prototype.limitSigDigs) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: Number.limitSigDigs
|
* APIMethod: Number.limitSigDigs
|
||||||
* Deprecated. Limit the number of significant digits on an integer. Does *not*
|
* *Deprecated*. Limit the number of significant digits on an integer. Does *not*
|
||||||
* work with floats!
|
* work with floats!
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
@@ -266,7 +266,7 @@ OpenLayers.Function = {
|
|||||||
if (!Function.prototype.bind) {
|
if (!Function.prototype.bind) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: Function.bind
|
* APIMethod: Function.bind
|
||||||
* Deprecated. Bind a function to an object.
|
* *Deprecated*. Bind a function to an object.
|
||||||
* Method to easily create closures with 'this' altered.
|
* Method to easily create closures with 'this' altered.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
@@ -290,7 +290,7 @@ if (!Function.prototype.bind) {
|
|||||||
if (!Function.prototype.bindAsEventListener) {
|
if (!Function.prototype.bindAsEventListener) {
|
||||||
/**
|
/**
|
||||||
* APIMethod: Function.bindAsEventListener
|
* APIMethod: Function.bindAsEventListener
|
||||||
* Deprecated. Bind a function to an object, and configure it to receive the
|
* *Deprecated*. Bind a function to an object, and configure it to receive the
|
||||||
* event object as first parameter when called.
|
* event object as first parameter when called.
|
||||||
*
|
*
|
||||||
* Parameters:
|
* Parameters:
|
||||||
|
|||||||
Reference in New Issue
Block a user