diff --git a/types/nodegit/branch.d.ts b/types/nodegit/branch.d.ts index d121650864..4c48d32101 100644 --- a/types/nodegit/branch.d.ts +++ b/types/nodegit/branch.d.ts @@ -12,14 +12,116 @@ export namespace Branch { } export class Branch { - static create(repo: Repository, branch_name: string, target: Commit, force: number): Promise; - static createFromAnnotated(repository: Repository, branch_name: string, commit: AnnotatedCommit, force: number): Reference; + /** + * + * + * @static + * @param {Repository} repo + * @param {string} branchName + * @param {Commit} target + * @param {number} force + * @returns {Promise} + * + * @memberof Branch + */ + static create(repo: Repository, branchName: string, target: Commit, force: number): Promise; + /** + * + * + * @static + * @param {Repository} repository + * @param {string} branchName + * @param {AnnotatedCommit} commit + * @param {number} force + * @returns {Reference} + * + * @memberof Branch + */ + static createFromAnnotated(repository: Repository, branchName: string, commit: AnnotatedCommit, force: number): Reference; + /** + * + * + * @static + * @param {Reference} branch + * @returns {number} + * + * @memberof Branch + */ static delete(branch: Reference): number; + /** + * + * + * @static + * @param {Reference} branch + * @returns {number} + * + * @memberof Branch + */ static isHead(branch: Reference): number; - static iteratorNew(repo: Repository, list_flags: number): Promise; - static lookup(repo: Repository, branch_name: string, branch_type: number): Promise; - static move(branch: Reference, new_branch_name: string, force: number): Promise; + /** + * + * + * @static + * @param {Repository} repo + * @param {number} listFlags + * @returns {Promise} + * + * @memberof Branch + */ + static iteratorNew(repo: Repository, listFlags: number): Promise; + /** + * + * + * @static + * @param {Repository} repo + * @param {string} branchName + * @param {number} branchType + * @returns {Promise} + * + * @memberof Branch + */ + static lookup(repo: Repository, branchName: string, branchType: number): Promise; + /** + * + * + * @static + * @param {Reference} branch + * @param {string} newBranchName + * @param {number} force + * @returns {Promise} + * + * @memberof Branch + */ + static move(branch: Reference, newBranchName: string, force: number): Promise; + /** + * + * + * @static + * @param {Reference} ref + * @returns {Promise} + * + * @memberof Branch + */ static name(ref: Reference): Promise; - static setUpstream(branch: Reference, upstream_name: string): Promise; + /** + * + * + * @static + * @param {Reference} branch + * @param {string} upstreamName + * @returns {Promise} + * + * @memberof Branch + */ + static setUpstream(branch: Reference, upstreamName: string): Promise; + /** + * + * + * @static + * @param {Reference} branch + * @returns {Promise} + * + * @memberof Branch + */ static upstream(branch: Reference): Promise; }