From 1452a76dac77ef625542eee5ce48a8f78f7c3161 Mon Sep 17 00:00:00 2001
From: Mariusz Nowak <mariusz@medikoo.com>
Date: Fri, 21 Sep 2012 15:49:09 +0200
Subject: [PATCH] Basic documentation for each module

---
 lib/_base.js           | 2 ++
 lib/ext/async.js       | 2 ++
 lib/ext/dispose.js     | 2 ++
 lib/ext/max-age.js     | 2 ++
 lib/ext/max.js         | 2 ++
 lib/ext/method.js      | 2 ++
 lib/ext/profile.js     | 2 ++
 lib/ext/ref-counter.js | 2 ++
 lib/ext/resolvers.js   | 2 ++
 lib/index.js           | 4 +++-
 lib/primitive.js       | 2 ++
 lib/regular.js         | 2 ++
 12 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/lib/_base.js b/lib/_base.js
index 22620ac..8db622a 100644
--- a/lib/_base.js
+++ b/lib/_base.js
@@ -1,3 +1,5 @@
+// To be used internally, memoize factory
+
 'use strict';
 
 var callable   = require('es5-ext/lib/Object/valid-callable')
diff --git a/lib/ext/async.js b/lib/ext/async.js
index caf4705..d397fcc 100644
--- a/lib/ext/async.js
+++ b/lib/ext/async.js
@@ -1,3 +1,5 @@
+// Support for asynchronous functions
+
 'use strict';
 
 var toArray    = require('es5-ext/lib/Array/from')
diff --git a/lib/ext/dispose.js b/lib/ext/dispose.js
index f3f6447..1c8ad48 100644
--- a/lib/ext/dispose.js
+++ b/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')
diff --git a/lib/ext/max-age.js b/lib/ext/max-age.js
index 176859c..d21bb35 100644
--- a/lib/ext/max-age.js
+++ b/lib/ext/max-age.js
@@ -1,3 +1,5 @@
+// Timeout cached values
+
 'use strict';
 
 var forEach = require('es5-ext/lib/Object/for-each')
diff --git a/lib/ext/max.js b/lib/ext/max.js
index c3bc9a3..1437f38 100644
--- a/lib/ext/max.js
+++ b/lib/ext/max.js
@@ -1,3 +1,5 @@
+// Limit cache size with LRU (least recently used) alogrithm.
+
 'use strict';
 
 var ext = require('../_base').ext;
diff --git a/lib/ext/method.js b/lib/ext/method.js
index 34b5727..09b5aff 100644
--- a/lib/ext/method.js
+++ b/lib/ext/method.js
@@ -1,3 +1,5 @@
+// Memoized methods factory
+
 'use strict';
 
 var global   = require('es5-ext/lib/global')
diff --git a/lib/ext/profile.js b/lib/ext/profile.js
index 709c048..af6d9df 100644
--- a/lib/ext/profile.js
+++ b/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')
diff --git a/lib/ext/ref-counter.js b/lib/ext/ref-counter.js
index 4b0c288..6c0ee95 100644
--- a/lib/ext/ref-counter.js
+++ b/lib/ext/ref-counter.js
@@ -1,3 +1,5 @@
+// Reference counter, useful for garbage collector like functionality
+
 'use strict';
 
 var ext = require('../_base').ext;
diff --git a/lib/ext/resolvers.js b/lib/ext/resolvers.js
index ac9533d..47d9605 100644
--- a/lib/ext/resolvers.js
+++ b/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')
diff --git a/lib/index.js b/lib/index.js
index bc5f607..00bc70c 100644
--- a/lib/index.js
+++ b/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');
diff --git a/lib/primitive.js b/lib/primitive.js
index 04a569d..29224ed 100644
--- a/lib/primitive.js
+++ b/lib/primitive.js
@@ -1,3 +1,5 @@
+// Memoize working in primitive mode
+
 'use strict';
 
 var hasListeners = require('event-emitter/lib/has-listeners')
diff --git a/lib/regular.js b/lib/regular.js
index 5da3829..0febbef 100644
--- a/lib/regular.js
+++ b/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')