build: more JSDocs

TooTallNate · May 11, 2014 · 1bf6f8d · 1bf6f8d
1 parent 40cb474
commit 1bf6f8d
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/lib/build.js b/lib/build.js
@@ -12,6 +12,14 @@ var xmlbuilder = require('xmlbuilder');
 
 exports.build = build;
 
+/**
+ * Accepts a `Date` instance and returns an ISO date string.
+ *
+ * @param {Date} d - Date instance to serialize
+ * @returns {String} ISO date string representation of `d`
+ * @api private
+ */
+
 function ISODateString(d){
   function pad(n){
     return n < 10 ? '0' + n : n;
@@ -40,10 +48,10 @@ function type (obj) {
 }
 
 /**
- * generate an XML plist string from the input object
+ * Generate an XML plist string from the input object `obj`.
  *
  * @param {Object} obj - the object to convert
- * @returns {String} converted plist
+ * @returns {String} converted plist XML string
  * @api public
  */