Fixing array return formatting in docs

aheuermann · aheuermann · commit 3676546a402b · 2015-07-10T21:11:13.000-05:00
diff --git a/lib/convenient_hunk.js b/lib/convenient_hunk.js
@@ -28,7 +28,8 @@ ConvenientHunk.prototype.size = function() {
 
 /**
  * The lines in this hunk
- * @return Promise({[ConvenientLine]})  a promise that resolves to an array of
+ * @async
+ * @return {Array<ConvenientLine>}  a promise that resolves to an array of
  *                                      ConvenientLines
  */
 ConvenientHunk.prototype.lines = function() {
diff --git a/lib/convenient_patch.js b/lib/convenient_patch.js
@@ -35,7 +35,8 @@ ConvenientPatch.prototype.size = function() {
 
 /**
  * The hunks in this patch
- * @return Promise({[ConvenientHunk]})  a promise that resolves to an array of
+ * @async
+ * @return {Array<ConvenientHunk>}  a promise that resolves to an array of
  *                                      ConvenientHunks
  */
 ConvenientPatch.prototype.hunks = function() {
diff --git a/lib/diff.js b/lib/diff.js
@@ -9,7 +9,8 @@ var Patch = NodeGit.Patch;
 /**
  * Retrieve patches in this difflist
  *
- * @return Promise({[ConvenientPatch]}) a promise that resolves to an array of
+ * @async
+ * @return {Array<ConvenientPatch>} a promise that resolves to an array of
  *                                      ConvenientPatches
  */
 Diff.prototype.patches = function() {
diff --git a/lib/tree.js b/lib/tree.js
@@ -82,7 +82,7 @@ Tree.prototype.getEntry = function(filePath, callback) {
 
 /**
  * Return an array of the entries in this tree (excluding its children).
- * @return {[TreeEntry]} an array of TreeEntrys
+ * @return {Array<TreeEntry>} an array of TreeEntrys
  */
 Tree.prototype.entries = function() {
   var size = this.entryCount();
