Changeset 15152 for trunk/FACT++

Timestamp:

03/25/13 09:54:14 (12 years ago)

Author:

tbretz

Message:

Added desription for String.count

File:

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

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

@@ -100 +100 @@
  */
 String.prototype.$ = function() { /* [native code] */ };
+
+/**
+ * Like String match, but return the number counts how often
+ * the regular expression matches.
+ *
+ * @param {String} regex
+ *     The regular expression to search for, e.g., "s" (to count the s's) or
+ *     "As+A" (to count how often s's are surrounded by A's)
+ *
+ * @param {Boolean} [case=false]
+ *     Search is case insensitive if set to true.
+ *
+ * @returns {Interger}
+ *     The number of occurances of the regular expression
+ *
+ * @example
+ *    var result = "Thomas Bretz".count("[hme]"); // returns 3
+ *
+ * @author <a href="mailto:thomas.bretz@epfl.ch">Thomas Bretz</a>
+ */
+String.prototype.count = function() { /* [native code] */ };