Fix #6913 - add more documentation to code

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

diff --git a/docs/symbols/Roo.util.TaskRunner.json b/docs/symbols/Roo.util.TaskRunner.json
new file mode 100644 (file)
index 0000000..345b5a9
--- /dev/null
+++ b/docs/symbols/Roo.util.TaskRunner.json
@@ -0,0 +1,97 @@
+{
+  "name" : "Roo.util.TaskRunner",
+  "augments" : [],
+  "childClasses" : {  },
+  "tree_children" : [],
+  "tree_parent" : [],
+  "desc" : "Manage background tasks - not sure why this is better that setInterval?",
+  "isSingleton" : false,
+  "isStatic" : true,
+  "isBuiltin" : false,
+  "isAbstract" : false,
+  "isBuilderTop" : false,
+  "memberOf" : "TaskRunner",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [],
+  "returns" : [],
+  "throws" : "",
+  "requires" : "",
+  "config" : [],
+  "methods" : [
+    {
+      "name" : "stop",
+      "type" : "function",
+      "desc" : "Stop  new task.",
+      "sig" : "(task)",
+      "static" : false,
+      "memberOf" : "",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "exceptions" : "",
+      "requires" : "",
+      "params" : [
+        {
+          "name" : "task",
+          "type" : "Object",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : []
+    },
+    {
+      "name" : "stopAll",
+      "type" : "function",
+      "desc" : "Stop all Tasks",
+      "sig" : "()\n{\n\n}",
+      "static" : false,
+      "memberOf" : "",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "exceptions" : "",
+      "requires" : "",
+      "params" : [],
+      "returns" : []
+    },
+    {
+      "name" : "start",
+      "type" : "function",
+      "desc" : "Queues a new task.",
+      "sig" : "(task)",
+      "static" : false,
+      "memberOf" : "",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "exceptions" : "",
+      "requires" : "",
+      "params" : [
+        {
+          "name" : "task",
+          "type" : "Object",
+          "desc" : "Task property : interval = how frequent to run.\nTask object should implement\nfunction run()\nTask object may implement\nfunction onStop()",
+          "isOptional" : false
+        }
+      ],
+      "returns" : []
+    }
+  ],
+  "events" : []
+}
\ No newline at end of file