Changeset 18819 for trunk/FACT++/scripts/doc

Timestamp:

04/14/17 11:55:44 (8 years ago)

Author:

tbretz

Message:

Improved comments, removed wrong 'version' property

File:

• trunk/FACT++/scripts/doc/_global_.js (modified) (5 diffs)

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

@@ -15 +15 @@
 /**
  * An associative array containing the user supplied arguments identical to arg.
+ * Positional arguments (arguments without value) are stored as 'n'="value"
+ * and can be accessed via $[n] with n being an integer.
  *
  * @static
@@ -21 +23 @@
  * @example
  *    var value = $['name'];
- *
  */
 _global_.$ = [];
@@ -27 +28 @@
 /**
  * An associative array containing the user supplied arguments identical to $.
+ * Positional arguments (arguments without value) are listed as 'n'="value"
+ * and can be accessed via arg[n] with n being an iteger.
  *
  * @static
@@ -32 +35 @@
  *
  * @example
+ *    // List all arguments
  *    for (var key in arg)
  *        console.out("arg["+key+"]="+arg[key]);
+ *
+ *    // List only positional arguments
+ *    for (var i=0; i<arg.length; i++)
+ *        console.out("arg["+i+"]="+arg[i]);
  */
 _global_.arg = [];
@@ -111 +119 @@
 
 /**
- *
- * @returns {String}
- *    A string with the JavaScript V8 version is returned.
- *
- * @static
- *
- */
-_global_.version = function() { /* [native code] */  }
-
-/**
  * Reads a file as a whole.
  *