Merge ~richardw/jarmon/auto-apidocumentationv10.8pre1

 * Cleanup and add further doc strings for compatibility with yuidoc
 * Add a tool to automatically download and run yuidoc on the source tree
 * Add a tool to automatically create a releasable source archive containing apidocs
 * Add documentation of the apidoc and release tools.
 * Rearrange the source tree - moving all examples into the docs/examplesfolder

1 files changed, 88 insertions, 0 deletions

diff --git a/docs/examples/jarmon_example_recipes.js b/docs/examples/jarmon_example_recipes.js
new file mode 100644
index 0000000..90b5c2e
--- /dev/null
+++ b/docs/examples/jarmon_example_recipes.js
@@ -0,0 +1,88 @@
+/* Copyright (c) 2010 Richard Wall <richard (at) the-moon.net>
+ * See LICENSE for details.
+ *
+ * Some example recipes for Collectd RRD data - you *will* need to modify this
+ * based on the RRD data available on your system.
+ */
+
+if(typeof jarmon == 'undefined') {
+    var jarmon = {};
+}
+
+jarmon.COLLECTD_RECIPES = {
+    'cpu': [
+        {
+            title: 'CPU Usage',
+            data: [
+                ['data/cpu-0/cpu-wait.rrd', 0, 'CPU-0 Wait', '%'],
+                ['data/cpu-1/cpu-wait.rrd', 0, 'CPU-1 Wait', '%'],
+                ['data/cpu-0/cpu-system.rrd', 0, 'CPU-0 System', '%'],
+                ['data/cpu-1/cpu-system.rrd', 0, 'CPU-1 System', '%'],
+                ['data/cpu-0/cpu-user.rrd', 0, 'CPU-0 User', '%'],
+                ['data/cpu-1/cpu-user.rrd', 0, 'CPU-1 User', '%']
+            ],
+            options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS,
+                                             jarmon.Chart.STACKED_OPTIONS)
+        }
+    ],
+
+    'memory': [
+        {
+            title: 'Memory',
+            data: [
+                ['data/memory/memory-buffered.rrd', 0, 'Buffered', 'B'],
+                ['data/memory/memory-used.rrd', 0, 'Used', 'B'],
+                ['data/memory/memory-cached.rrd', 0, 'Cached', 'B'],
+                ['data/memory/memory-free.rrd', 0, 'Free', 'B']
+            ],
+            options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS,
+                                             jarmon.Chart.STACKED_OPTIONS)
+        }
+    ],
+
+    'dns': [
+        {
+            title: 'DNS Query Types',
+            data: [
+                ['data/dns/dns_qtype-A.rrd', 0, 'A', 'Q/s'],
+                ['data/dns/dns_qtype-PTR.rrd', 0, 'PTR', 'Q/s'],
+                ['data/dns/dns_qtype-SOA.rrd', 0, 'SOA', 'Q/s'],
+                ['data/dns/dns_qtype-SRV.rrd', 0, 'SRV', 'Q/s']
+            ],
+            options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS)
+        },
+
+        {
+            title: 'DNS Return Codes',
+            data: [
+                ['data/dns/dns_rcode-NOERROR.rrd', 0, 'NOERROR', 'Q/s'],
+                ['data/dns/dns_rcode-NXDOMAIN.rrd', 0, 'NXDOMAIN', 'Q/s'],
+                ['data/dns/dns_rcode-SERVFAIL.rrd', 0, 'SERVFAIL', 'Q/s']
+            ],
+            options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS)
+        }
+    ],
+
+    'load': [
+        {
+            title: 'Load Average',
+            data: [
+                ['data/load/load.rrd', 'shortterm', 'Short Term', ''],
+                ['data/load/load.rrd', 'midterm', 'Medium Term', ''],
+                ['data/load/load.rrd', 'longterm', 'Long Term', '']
+            ],
+            options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS)
+        }
+    ],
+
+    'interface': [
+        {
+            title: 'Wlan0 Throughput',
+            data: [
+                ['data/interface/if_octets-wlan0.rrd', 'tx', 'Transmit', 'b/s'],
+                ['data/interface/if_octets-wlan0.rrd', 'rx', 'Receive', 'b/s']
+            ],
+            options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS)
+        }
+    ]
+};