Updated documentation

faceleg · faceleg · commit fb0561bcd3ea · 2013-04-03T00:06:07.000+13:00
diff --git a/lib/blob.js b/lib/blob.js
@@ -4,8 +4,9 @@ var git = require('../'),
 /**
  * Blob convenience class constructor.
  *
- * @param {git.raw.Repo} rawRepo
- * @param {git.raw.Blob|null} rawBlob
+ * @constructor
+ * @param {git.raw.Repo} rawRepo Raw repository object.
+ * @param {git.raw.Blob} [rawBlob = new git.raw.Blob(rawRepo)] Raw blob object.
  */
 var Blob = function(rawRepo, rawBlob) {
   if(!(rawRepo instanceof git.raw.Repo)) {
@@ -24,10 +25,15 @@ var Blob = function(rawRepo, rawBlob) {
 /**
  * Retrieve the blob represented by the oid.
  *
- * @param  {git.raw.Oid} oid
- * @param  {Function} callback
+ * @param  {git.raw.Oid} oid The OID representing the blob to lookup.
+ * @param {Blob~lookupCallback} callback
  */
 Blob.prototype.lookup = function(oid, callback) {
+  /**
+   * @callback Blob~lookupCallback Callback executed on lookup completion.
+   * @param {GitError|null} error An Error or null if successful.
+   * @param {Blob|null} blob The populated blob object or null.
+   */
   var self = this;
   self.rawBlob.lookup(self.rawRepo, oid, function blobLookup(error, rawBlob) {
     if (success(error, callback)) {
@@ -40,9 +46,14 @@ Blob.prototype.lookup = function(oid, callback) {
 /**
  * Retrieve the blob's raw content buffer.
  *
- * @param  {Function} callback
+ * @param {Blob~rawContentCallback} callback
  */
 Blob.prototype.rawContent = function(callback) {
+  /**
+   * @callback Blob~rawContentCallback Callback executed after raw content is retrieved.
+   * @param {GitError|null} error An Error or null if successful.
+   * @param {Buffer|null} content The raw content of the blob or null.
+   */
   this.rawBlob.rawContent(function(error, content) {
     if (success(error, callback)) {
       callback(null, content);
@@ -53,9 +64,14 @@ Blob.prototype.rawContent = function(callback) {
 /**
  * Retrieve the blob's content.
  *
- * @param  {Function} callback
+ * @param {Blob~contentCallback} callback
  */
 Blob.prototype.content = function(callback) {
+  /**
+   * @callback Blob~contentCallback Callback executed after content is retrieved.
+   * @param {GitError|null} error An Error or null if successful.
+   * @param {String|null} content The content of the blob or null.
+   */
   this.rawContent(function(error, content) {
     if (success(error, callback)) {
       callback(null, content.toString());
