major doc changes

[roojs1] / docs / symbols / Roo.util.Format.json

diff --git a/docs/symbols/Roo.util.Format.json b/docs/symbols/Roo.util.Format.json
index 2e053ff..447cc32 100644 (file)
--- a/docs/symbols/Roo.util.Format.json
+++ b/docs/symbols/Roo.util.Format.json
@@ -1,10 +1,15 @@
 {
   "name" : "Roo.util.Format",
   "augments" : [],
+  "childClasses" : {  },
+  "tree_children" : [],
+  "tree_parent" : [],
   "desc" : "Reusable data formatting functions",
   "isSingleton" : true,
   "isStatic" : false,
   "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
   "memberOf" : "Format",
   "example" : "",
   "deprecated" : "",
@@ -12,19 +17,26 @@
   "see" : "",
   "params" : [],
   "returns" : [],
+  "throws" : "",
+  "requires" : "",
   "config" : [],
   "methods" : [
     {
       "name" : "uppercase",
+      "type" : "function",
       "desc" : "Converts a string to all upper case letters",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -43,15 +55,20 @@
     },
     {
       "name" : "date",
+      "type" : "function",
       "desc" : "Parse a value into a formatted date using the specified format pattern.",
+      "sig" : "(value, format)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -76,15 +93,20 @@
     },
     {
       "name" : "lowercase",
+      "type" : "function",
       "desc" : "Converts a string to all lower case letters",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -103,15 +125,20 @@
     },
     {
       "name" : "undef",
+      "type" : "function",
       "desc" : "Checks a reference and converts it to empty string if it is undefined",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -130,15 +157,20 @@
     },
     {
       "name" : "stripTags",
+      "type" : "function",
       "desc" : "Strips all HTML tags",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -157,15 +189,20 @@
     },
     {
       "name" : "ellipsis",
+      "type" : "function",
       "desc" : "Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length",
+      "sig" : "(value, length)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -190,15 +227,20 @@
     },
     {
       "name" : "htmlDecode",
+      "type" : "function",
       "desc" : "Convert certain characters (&, <, >, and ') from their HTML character equivalents.",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -217,15 +259,20 @@
     },
     {
       "name" : "htmlEncode",
+      "type" : "function",
       "desc" : "Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages.",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -244,15 +291,20 @@
     },
     {
       "name" : "size",
+      "type" : "function",
       "desc" : "Size in Mb,Gb etc.",
+      "sig" : "(value, decimals)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -277,15 +329,20 @@
     },
     {
       "name" : "toFixed",
+      "type" : "function",
       "desc" : "safer version of Math.toFixed..??/",
+      "sig" : "(value, value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -310,15 +367,20 @@
     },
     {
       "name" : "substr",
+      "type" : "function",
       "desc" : "Returns a substring from within an original string",
+      "sig" : "(value, start, length)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -349,15 +411,20 @@
     },
     {
       "name" : "number",
+      "type" : "function",
       "desc" : "Format a number\neventually this should probably emulate php's number_format",
+      "sig" : "(value, decimals, delimiter)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -388,15 +455,20 @@
     },
     {
       "name" : "usMoney",
+      "type" : "function",
       "desc" : "Format a number as US currency",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -415,15 +487,20 @@
     },
     {
       "name" : "capitalize",
+      "type" : "function",
       "desc" : "Converts the first character only of a string to upper case",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -442,15 +519,20 @@
     },
     {
       "name" : "trim",
+      "type" : "function",
       "desc" : "Trims any whitespace from either side of a string",
+      "sig" : "(value)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "value",
@@ -469,15 +551,20 @@
     },
     {
       "name" : "dateRenderer",
+      "type" : "function",
       "desc" : "Returns a date rendering function that can be reused to apply a date format multiple times efficiently",
+      "sig" : "(format)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.util.Format",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "format",