Changeset 179 for trunk/docs/api

Timestamp:

Apr 20, 2011, 12:16:05 AM (14 years ago)

Author:

jmckenna

Message:

add missing function details

File:

• trunk/docs/api/zoo-string.txt (modified) (2 diffs)

trunk/docs/api/zoo-string.txt

@@ -35 +35 @@
 
 startsWith
+  ::
+  
+    startsWith: function(str,sub)
+
   Test whether a string starts with another string.
 
+  *Parameters*
+  
+  | ``str {String}`` The string to test.
+  | ``sub {Sring}`` The substring to look for.
+
+  *Returns*
+
+  ``{Boolean}`` The first string starts with the second.
+  
 .. _contains:
 
 contains        
+  ::
+  
+    contains: function(str,sub)
+
   Test whether a string contains another string.
 
+  *Parameters*
+  
+  | ``str {String}`` The string to test.
+  | ``sub {String}`` The substring to look for.
+
+  *Returns*
+
+  ``{Boolean}`` The first string contains the second.
+  
 .. _trim:
 
 trim    
+  ::
+  
+    trim: function(str)
+
   Removes leading and trailing whitespace characters from a string.
+
+  *Parameters*
+  
+  ``str {String}`` The (potentially) space-padded string. This string is not modified.
+
+  *Returns*
+
+  ``{String}`` A trimmed version of the string with all leading and trailing spaces removed.
 
 .. _camelize:
 
 camelize        
-  Camel-case a hyphenated string.
+  ::
+  
+    camelize: function(str)
+
+  Camel-case a hyphenated string. Ex. "chicken-head" becomes "chickenHead", and "-chicken-head" becomes "ChickenHead".
+
+  *Parameters*
+  
+  ``str {String}`` The string to be camelized.  The original is not modified.
+
+  *Returns*
+
+  ``{String}`` The string, camelized  
   
 .. _tokenRegEx:  
   
 tokenRegEx      
-  Used to find tokens in a string.
+  Used to find tokens in a string.  Examples: *${a}, ${a.b.c}, ${a-b}, ${5}*
   
 .. _numberRegEx:    
@@ -65 +115 @@
   
 isNumeric       
+  ::
+  
+    isNumeric: function(value)
+
   Determine whether a string contains only a numeric value.
+
+  *Examples*
+
+  ::
+  
+    ZOO.String.isNumeric("6.02e23") // true
+    ZOO.String.isNumeric("12 dozen") // false
+    ZOO.String.isNumeric("4") // true
+    ZOO.String.isNumeric(" 4 ") // false
+
+  *Returns*
+
+  ``{Boolean}`` String contains only a number. 
   
 .. _numericIf:  
 
 numericIf       
+  ::
+  
+    numericIf: function(value)
+
   Converts a string that appears to be a numeric value into a number.
+
+  *Returns*
+  
+  ``{Number|String}`` a Number if the passed value is a number, a String otherwise.