docs

mongoosejs · Feb 9, 2012 · 0e899a9 · 0e899a9
1 parent 48b5492
commit 0e899a9
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -8,6 +8,14 @@ module.exports = exports = function keywordize (schema, options) {
 
   schema.add({ keywords: [String] });
 
+  /**
+   * Keywordize.
+   *
+   * Breaks apart field values into separate keywords.
+   * @return {MongooseArray}
+   * @api public
+   */
+
   schema.methods.keywordize = function () {
     var self = this;
 
@@ -41,6 +49,10 @@ module.exports = exports = function keywordize (schema, options) {
     this.keywords = keywords;
   }
 
+  /**
+   * Update the keywords if any field changed.
+   */
+
   schema.pre('save', function (next) {
     var self = this;
 
@@ -53,4 +65,8 @@ module.exports = exports = function keywordize (schema, options) {
   });
 }
 
+/**
+ * Expose version.
+ */
+
 exports.version = '0.0.1';