Changeset 14740 for trunk/FACT++/scripts

Timestamp:

12/08/12 13:28:02 (12 years ago)

Author:

tbretz

Message:

Added description for new function dim.getStates

File:

• trunk/FACT++/scripts/doc/dim.js (modified) (2 diffs)

trunk/FACT++/scripts/doc/dim.js

@@ -140 +140 @@
 /**
  *
+ * Returns a list of all known state of a given server.
+ *
+ * The returned object has all states with their index as property.
+ * Each state is returned as a String object with the property description.
+ *
+ * @param {String} [server='DIM_CONTROL']
+ *     Name of the server for which states should be listed.
+ *     The states of the DIM_CONTROl server are the default.
+ *
+ * @type Object[StringObject]
+ *
+ * @example
+ *     var states = dim.getStates("SERVER");
+ *     console.out(JSON.stringify(states));
+ *     for (var index in states)
+ *         console.out(index+"="+states[index]+": "+states[index].description);
+ */
+dim.getStates = function() { /* [native code] */ }
+
+/**
+ *
  * Callback in case of state changes.
  *
@@ -165 +186 @@
 dim.onchange = [];
 
+
 /**
  * DIM version number