More internal documentation

tmcw · tmcw · commit 04355a8b9121 · 2016-06-02T13:35:27.000-04:00
diff --git a/lib/commands/build.js b/lib/commands/build.js
@@ -10,6 +10,12 @@ var streamArray = require('stream-array'),
 module.exports = build;
 module.exports.description = 'build documentation';
 
+/**
+ * Add yargs parsing for the build command
+ * @param {Object} yargs module instance
+ * @returns {Object} yargs with options
+ * @private
+ */
 module.exports.parseArgs = function (yargs) {
   return sharedOptions.sharedOutputOptions(
     sharedOptions.sharedInputOptions(yargs))
diff --git a/lib/commands/lint.js b/lib/commands/lint.js
@@ -4,12 +4,28 @@
 
 module.exports = lint;
 module.exports.description = 'check for common style and uniformity mistakes';
+
+/**
+ * Add yargs parsing for the lint command
+ * @param {Object} yargs module instance
+ * @returns {Object} yargs with options
+ * @private
+ */
 module.exports.parseArgs = function (yargs) {
   return yargs
     .example('documentation lint project.js', 'check documentation style')
     .help('help');
 };
 
+/**
+ * Wrap around the documentation.lint method and add the additional
+ * behavior of printing to stdout and setting an exit status.
+ *
+ * @param {Object} documentation self-module instance
+ * @param {Object} parsedArgs cli arguments
+ * @returns {undefined} has side-effects
+ * @private
+ */
 function lint(documentation, parsedArgs) {
   documentation.lint(parsedArgs.inputs, parsedArgs.options, function (err, lintOutput) {
     if (err) {
diff --git a/lib/commands/readme.js b/lib/commands/readme.js
@@ -9,6 +9,12 @@ var build = require('./build');
 
 module.exports = readme;
 module.exports.description = 'inject documentation into your README.md';
+/**
+ * Add yargs parsing for the readme command
+ * @param {Object} yargs module instance
+ * @returns {Object} yargs with options
+ * @private
+ */
 module.exports.parseArgs = function (yargs) {
   return yargs.usage('Usage: documentation readme [--readme-file=README.md] --section "API"' +
     ' [--compare-only] [other documentationjs options]')
diff --git a/lib/commands/serve.js b/lib/commands/serve.js
@@ -8,6 +8,12 @@ var build = require('./build');
 
 module.exports = serve;
 module.exports.description = 'generate, update, and display HTML documentation';
+/**
+ * Add yargs parsing for the serve command
+ * @param {Object} yargs module instance
+ * @returns {Object} yargs with options
+ * @private
+ */
 module.exports.parseArgs = function (yargs) {
   return sharedOptions.sharedOutputOptions(
       sharedOptions.sharedInputOptions(yargs));
diff --git a/lib/server.js b/lib/server.js
@@ -33,6 +33,16 @@ Server.prototype.setFiles = function (files) {
   return this;
 };
 
+/**
+ * Internal handler for server requests. The server serves
+ * very few types of things: html, images, and so on, and it
+ * only handles GET requests.
+ *
+ * @param {http.Request} request content wanted
+ * @param {http.Response} response content returned
+ * @returns {undefined} nothing
+ * @private
+ */
 Server.prototype.handler = function (request, response) {
   var path = request.url.substring(1);
   if (path === '') {
