Added documentation. Fixed issue #1.

Author: emmanuel

lib/fawn.js

@@ -11,6 +11,7 @@ var collection;
 var TaskMdl;
 var Task;
 var Roller;
+var utils;
 
 var Fawn = {
   init: function(db, _collection, options){
@@ -38,6 +39,7 @@ var Fawn = {
     TaskMdl = require("../models/task")(mongoose, collection);
     Task = require("./task")(mongoose, TaskMdl);
     Roller = require("./roller")(mongoose, TaskMdl);
+    utils = require("./utils")(mongoose);
   }
 
   , Task: function(){
@@ -49,6 +51,11 @@ var Fawn = {
     checkInitStatus();
     return Roller;
   }
+
+  , initModel: function (modelName, schema) {
+    checkInitStatus();
+    utils.initModel(modelName, schema);
+  }
 };
 
 function checkInitStatus(){

lib/roller.js

@@ -19,6 +19,15 @@ var utils;
 var updateState;
 var getModel;
 
+/**
+ * Initializes variables and gets the roller.
+ *
+ * @param mongoose the mongoose instance
+ * @param _TaskMdl the task model
+ *
+ * @returns An object containing rollback functions
+ * @constructor
+ */
 var RollerProvider = function(mongoose, _TaskMdl){
   TaskMdl = _TaskMdl;
   utils = require("./utils")(mongoose);
@@ -29,6 +38,10 @@ var RollerProvider = function(mongoose, _TaskMdl){
 };
 
 var Roller = {
+
+  /**
+   * rolls back all incomplete tasks
+   */
   roll: function(){
     var chain = Promise.resolve();
 
@@ -46,6 +59,13 @@ var Roller = {
   , rollOne: rollBackTask
 };
 
+/**
+ * Rollback for a single task
+ *
+ * @param task the task to roll back
+ *
+ * @returns {Promise|*}
+ */
 function rollBackTask(task) {
   var chain = Promise.resolve();
   var lastIndex = task.steps.length - 1;
@@ -73,6 +93,13 @@ function rollBackTask(task) {
   });
 }
 
+/**
+ * Gets the correct rollback function for a step
+ *
+ * @param step the step to rollback
+ *
+ * @returns a function to rollback step
+ */
 function getRollbackFunc(step){
   switch(step.type){
     case SAVE: return rollbackSave;
@@ -81,6 +108,12 @@ function getRollbackFunc(step){
   }
 }
 
+/**
+ * Rollback for a save step
+ *
+ * @param save the save step
+ * @param task the task containing the step
+ */
 function rollbackSave(save, task) {
   var Collection = getModel(save.name);
 
@@ -89,6 +122,14 @@ function rollbackSave(save, task) {
   });
 }
 
+/**
+ * Rollback for delete or update step.
+ *
+ * @param step the step to update
+ * @param task the task containing the step.
+ *
+ * @returns {Promise|*}
+ */
 function rollbackDeleteOrUpdate(step, task){
   var Collection = getModel(step.name);
   var chain = Promise.resolve();