Basic documentation for each module

lib/_base.js

@@ -1,3 +1,5 @@
+// To be used internally, memoize factory
+
 'use strict';
 
 var callable   = require('es5-ext/lib/Object/valid-callable')

lib/ext/async.js

@@ -1,3 +1,5 @@
+// Support for asynchronous functions
+
 'use strict';
 
 var toArray    = require('es5-ext/lib/Array/from')

lib/ext/dispose.js

@@ -1,3 +1,5 @@
+// Call dispose callback on each cache purge
+
 'use strict';
 
 var callable = require('es5-ext/lib/Object/valid-callable')

lib/ext/max-age.js

@@ -1,3 +1,5 @@
+// Timeout cached values
+
 'use strict';
 
 var forEach = require('es5-ext/lib/Object/for-each')

lib/ext/max.js

@@ -1,3 +1,5 @@
+// Limit cache size with LRU (least recently used) alogrithm.
+
 'use strict';
 
 var ext = require('../_base').ext;

lib/ext/method.js

@@ -1,3 +1,5 @@
+// Memoized methods factory
+
 'use strict';
 
 var global   = require('es5-ext/lib/global')

lib/ext/profile.js

@@ -1,3 +1,5 @@
+// Gathers statistical data, and provides them in convinient form
+
 'use strict';
 
 var partial  = require('es5-ext/lib/Function/prototype/partial')

lib/ext/ref-counter.js

@@ -1,3 +1,5 @@
+// Reference counter, useful for garbage collector like functionality
+
 'use strict';
 
 var ext = require('../_base').ext;

lib/ext/resolvers.js

@@ -1,3 +1,5 @@
+// Normalize arguments before passing them to underlying function
+
 'use strict';
 
 var toArray    = require('es5-ext/lib/Array/from')

lib/index.js

@@ -1,3 +1,5 @@
+// Provides memoize with all options
+
 'use strict';
 
 var regular   = require('./regular')
@@ -5,7 +7,7 @@ var regular   = require('./regular')
 
   , call = Function.prototype.call;
 
-// Order is important!
+// Order is significant!
 require('./ext/dispose');
 require('./ext/resolvers');
 require('./ext/async');

lib/primitive.js

@@ -1,3 +1,5 @@
+// Memoize working in primitive mode
+
 'use strict';
 
 var hasListeners = require('event-emitter/lib/has-listeners')

lib/regular.js

@@ -1,3 +1,5 @@
+// Memoize working in object mode (supports any type of arguments)
+
 'use strict';
 
 var indexOf      = require('es5-ext/lib/Array/prototype/e-index-of')