Changeset 15273 for trunk/FACT++/scripts/doc/_global_.js

Timestamp:

04/07/13 23:51:06 (11 years ago)

Author:

tbretz

Message:

Added explanation for new magic variables.

File:

• trunk/FACT++/scripts/doc/_global_.js (modified) (1 diff)

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

@@ -36 +36 @@
  */
 _global_.arg = [];
+
+/**
+ * A magic variable which is always set to the filename of the
+ * JavaScript file currently executed, if any.
+ *
+ * @static
+ * @type String
+ *
+ * @example
+ *    console.out(__FILE__);
+ */
+_global_.__FILE__ = filename;
+
+/**
+ * A magic variable which is always set to the modification time of the
+ * JavaScript file currently executed, if any.
+ *
+ * @static
+ * @type Date
+ *
+ * @example
+ *    console.out(__DATE__);
+ */
+_global_.__DATE__ = filedate;
+
+/**
+ * A magic variable which is always set to the start time when the
+ * current JavaScript session was started.
+ *
+ * @static
+ * @constant
+ * @type Date
+ *
+ * @example
+ *    console.out(__START__);
+ */
+_global_.__START__ = starttime;