Finish internal documentation

tmcw · tmcw · commit dead5bb9f746 · 2016-06-02T15:00:12.000-04:00
diff --git a/lib/commands/serve.js b/lib/commands/serve.js
@@ -24,6 +24,14 @@ server.on('listening', function () {
   process.stdout.write('documentation.js serving on port 4001\n');
 });
 
+/**
+ * Wrap the documentation build command along with a server, making it possible
+ * to preview changes live
+ * @private
+ * @param {Object} documentation module instance
+ * @param {Object} parsedArgs cli input
+ * @returns {undefined} has side effects
+ */
 function serve(documentation, parsedArgs) {
   parsedArgs.commandOptions.format = 'html';
   build(documentation, parsedArgs, function (err, output) {
diff --git a/lib/infer/access.js b/lib/infer/access.js
@@ -2,7 +2,15 @@
 
 var shouldSkipInference = require('./should_skip_inference');
 
-module.exports = function (pattern) {
+/**
+ * Given a string with a pattern that might infer access level, like `^_`,
+ * create an inference method.
+ *
+ * @param {?string} pattern regexp-compatible pattern
+ * @returns {Function} inference method
+ * @private
+ */
+function inferAccessWithPattern(pattern) {
   var re = pattern && new RegExp(pattern);
 
   /**
@@ -21,4 +29,6 @@ module.exports = function (pattern) {
 
     return comment;
   });
-};
+}
+
+module.exports = inferAccessWithPattern;
diff --git a/lib/infer/membership.js b/lib/infer/membership.js
@@ -43,6 +43,12 @@ function extractIdentifiers(path) {
   var identifiers = [];
 
   path.traverse({
+    /**
+     * Add an identifier in a path to the identifiers array
+     * @param {Object} path ast path
+     * @returns {undefined} has side-effects
+     * @private
+     */
     Identifier: function (path) {
       identifiers.push(path.node.name);
     }
