From aa758ecf138139daebb8c03855281f02b6b75a3b Mon Sep 17 00:00:00 2001 From: John Haley Date: Wed, 24 Feb 2016 10:41:51 -0700 Subject: [PATCH] Fix docs on `Repository` --- lib/repository.js | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/lib/repository.js b/lib/repository.js index 1da4e29f5..61d221729 100644 --- a/lib/repository.js +++ b/lib/repository.js @@ -131,6 +131,7 @@ Repository.prototype.getBranchCommit = function(name, callback) { /** * Gets the branch that HEAD currently points to * Is an alias to head() + * * @async * @return {Reference} */ @@ -502,6 +503,7 @@ Repository.prototype.createCommit = function( /** * Creates a new commit on HEAD from the list of passed in files + * * @async * @param {Array} filesToAdd * @param {Signature} author @@ -586,6 +588,7 @@ Repository.prototype.defaultSignature = function() { /** * Lists out the remotes in the given repository. * +* @async * @param {Function} Optional callback * @return {Object} Promise object. */ @@ -602,6 +605,7 @@ Repository.prototype.getRemotes = function(callback) { /** * Gets a remote from the repo * + * @async * @param {String|Remote} remote * @param {Function} callback * @return {Remote} The remote object @@ -629,6 +633,7 @@ Repository.prototype.getRemote = function(remote, callback) { /** * Fetches from a remote * + * @async * @param {String|Remote} remote * @param {Object|FetchOptions} fetchOptions Options for the fetch, includes * callbacks for fetching @@ -663,6 +668,8 @@ Repository.prototype.fetch = function( /** * Fetches from all remotes. This is done in series due to deadlocking issues * with fetching from many remotes that can happen. + * + * @async * @param {Object|FetchOptions} fetchOptions Options for the fetch, includes * callbacks for fetching * @param {Function} callback @@ -728,6 +735,7 @@ Repository.prototype.fetchAll = function( /** * Merge a branch onto another branch * + * @async * @param {String|Reference} to * @param {String|Reference} from * @param {Signature} signature @@ -928,6 +936,7 @@ function performRebase(repository, rebase, signature, beforeNextFn) { /** * Rebases a branch onto another branch * + * @async * @param {String} branch * @param {String} upstream * @param {String} onto @@ -1006,6 +1015,7 @@ Repository.prototype.rebaseBranches = function( /** * Continues an existing rebase * + * @async * @param {Signature} signature Identity of the one performing the rebase * @param {Function} beforeNextFn Callback to be called before each step * of the rebase. If the callback returns a @@ -1176,6 +1186,7 @@ Repository.prototype.fetchheadForeach = function(callback) { /** * Stages or unstages line selection of a specified file + * * @async * @param {String|Array} filePath The relative path of this file in the repo * @param {Boolean} stageNew Set to stage new filemode. Unset to unstage. @@ -1250,6 +1261,7 @@ Repository.prototype.stageFilemode = function(filePath, stageNew) { /** * Stages or unstages line selection of a specified file + * * @async * @param {String} filePath The relative path of this file in the repo * @param {Array} newLines The array of DiffLine objects