Fix #5654 - roojspacker - get it working as a doc tool...

[roojs1] / docs / symbols / Roo.state.Provider.json

diff --git a/docs/symbols/Roo.state.Provider.json b/docs/symbols/Roo.state.Provider.json
new file mode 100644 (file)
index 0000000..5bf0cd7
--- /dev/null
+++ b/docs/symbols/Roo.state.Provider.json
@@ -0,0 +1,192 @@
+{
+  "name" : "Roo.state.Provider",
+  "augments" : [
+  ],
+  "desc" : "Abstract base class for state provider implementations. This class provides methods\nfor encoding and decoding <b>typed</b> variables including dates and defines the \nProvider interface.",
+  "isSingleton" : false,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "Provider",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+  ],
+  "returns" : [
+  ],
+  "config" : [
+  ],
+  "methods" : [
+    {
+      "name" : "clear",
+      "desc" : "Clears a value from the state",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "decodeValue",
+      "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "value",
+          "type" : "String",
+          "desc" : "The value to decode",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Mixed",
+          "desc" : "The decoded value"
+        }
+      ]
+    },
+    {
+      "name" : "get",
+      "desc" : "Returns the current value for a key",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        },
+        {
+          "name" : "defaultValue",
+          "type" : "Mixed",
+          "desc" : "A default value to return if the key's value is not found",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "Mixed",
+          "desc" : "The state data"
+        }
+      ]
+    },
+    {
+      "name" : "set",
+      "desc" : "Sets the value for a key",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "name",
+          "type" : "String",
+          "desc" : "The key name",
+          "isOptional" : false
+        },
+        {
+          "name" : "value",
+          "type" : "Mixed",
+          "desc" : "The value to set",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "encodeValue",
+      "desc" : "Encodes a value including type information.  Decode with {@link #decodeValue}.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.state.Provider",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "value",
+          "type" : "Mixed",
+          "desc" : "The value to encode",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "String",
+          "desc" : "The encoded value"
+        }
+      ]
+    }
+  ],
+  "events" : [
+    {
+      "name" : "statechange",
+      "desc" : "Fires when a state change occurs.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Provider",
+          "desc" : "This state provider",
+          "isOptional" : false
+        },
+        {
+          "name" : "key",
+          "type" : "String",
+          "desc" : "The state key which was changed",
+          "isOptional" : false
+        },
+        {
+          "name" : "value",
+          "type" : "String",
+          "desc" : "The encoded value for the state",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ]
+}
\ No newline at end of file