docs/comments

lib/file-utils.js

@@ -4,13 +4,24 @@ var _         = require("lodash");
 var utils     = require("./utils");
 
 var fileUtils = {
-
     /**
      * React to file-change events that occur on "core" namespace only
      * @param bs
      * @param data
      */
     changedFile: function (bs, data) {
+        /**
+         * If the event property is undefined, infer that it's a 'change'
+         * event due the fact this handler is for emitter.emit("file:changed")
+         */
+        if (_.isUndefined(data.event)) {
+            data.event = "change";
+        }
+        /**
+         * Chokidar always sends an 'event' property - which could be
+         * `add` `unlink` etc etc so we need to check for that and only
+         * respond to 'change', for now.
+         */
         if (data.event === "change") {
             if (!bs.paused && data.namespace === "core") {
                 if (_.isUndefined(data.log)) {

lib/public/init.js

@@ -5,16 +5,22 @@ var merge     = require("../cli/cli-options").merge;
 
 /**
  * @param {BrowserSync} browserSync
- * @param {String} [name]
+ * @param {String} [name] - instance name
  * @param {Object} pjson
  * @returns {Function}
  */
 module.exports = function (browserSync, name, pjson) {
 
     return function () {
 
+        /**
+         * Handle new + old signatures for init.
+         */
         var args = require("../args")(_.toArray(arguments));
 
+        /**
+         * If the current instance is already running, just return an error
+         */
         if (browserSync.active) {
             return args.cb(new Error("Instance: " + name + " is already running!"));
         }

lib/public/public-utils.js

@@ -11,8 +11,7 @@ module.exports = {
         emitter.emit("file:changed", {
             path:      path,
             log:       log,
-            namespace: "core",
-            event:     "change"
+            namespace: "core"
         });
     },
     /**

lib/public/reload.js

@@ -35,10 +35,18 @@ module.exports = function (emitter) {
             }
         }
 
+        /**
+         * Handle single sting paths such as
+         * reload("core.css")
+         */
         if (typeof opts === "string") {
             return publicUtils.emitChangeEvent(emitter, opts, true);
         }
 
+        /**
+         * Handle an array of file paths such as
+         * reload(["core.css, "ie.cess"])
+         */
         if (Array.isArray(opts)) {
 
             if (utils.willCauseReload(opts, defaultConfig.injectFileTypes)) {
@@ -50,6 +58,13 @@ module.exports = function (emitter) {
             });
         }
 
+        /**
+         * At this point the argument given was neither an object,
+         * array or string so we simply perform a reload. This is to
+         * allow the following syntax to work as expected
+         *
+         * reload();
+         */
         return publicUtils.emitBrowserReload(emitter);
     }