Comments for XRegExp.cache

slevithan · Aug 20, 2012 · 299da97 · 299da97
1 parent 8c411fb
commit 299da97
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/xregexp.js b/src/xregexp.js
@@ -566,7 +566,7 @@ var XRegExp = (function(undefined) {
 
 /**
  * Caches and returns the result of calling `XRegExp(pattern, flags)`. On any subsequent call with
- * the same pattern and flag combination, the cached copy is returned.
+ * the same pattern and flag combination, the cached copy of the regex is returned.
  * @memberOf XRegExp
  * @param {String} pattern Regex pattern string.
  * @param {String} [flags] Any combination of XRegExp flags.
@@ -578,16 +578,17 @@ var XRegExp = (function(undefined) {
  * }
  */
     self.cache = function(pattern, flags) {
-        // The regex object cache is never auto-flushed, even if the user adds new syntax tokens
         var key = pattern + '/' + (flags || '');
         return cache[key] || (cache[key] = self(pattern, flags));
     };
 
 // Intentionally undocumented
     self.cache.flush = function(cacheName) {
         if (cacheName === 'patterns') {
+            // Flush the pattern cache used by the `XRegExp` constructor
             patternCache = {};
         } else {
+            // Flush the regex object cache populated by `XRegExp.cache`
             cache = {};
         }
     };

diff --git a/xregexp-all.js b/xregexp-all.js
@@ -593,7 +593,7 @@ var XRegExp = (function(undefined) {
 
 /**
  * Caches and returns the result of calling `XRegExp(pattern, flags)`. On any subsequent call with
- * the same pattern and flag combination, the cached copy is returned.
+ * the same pattern and flag combination, the cached copy of the regex is returned.
  * @memberOf XRegExp
  * @param {String} pattern Regex pattern string.
  * @param {String} [flags] Any combination of XRegExp flags.
@@ -605,16 +605,17 @@ var XRegExp = (function(undefined) {
  * }
  */
     self.cache = function(pattern, flags) {
-        // The regex object cache is never auto-flushed, even if the user adds new syntax tokens
         var key = pattern + '/' + (flags || '');
         return cache[key] || (cache[key] = self(pattern, flags));
     };
 
 // Intentionally undocumented
     self.cache.flush = function(cacheName) {
         if (cacheName === 'patterns') {
+            // Flush the pattern cache used by the `XRegExp` constructor
             patternCache = {};
         } else {
+            // Flush the regex object cache populated by `XRegExp.cache`
             cache = {};
         }
     };