Added more documentation

This commit is contained in:
Dolan
2017-06-09 02:11:48 +01:00
parent 93a3dc1f47
commit 3fe8ca1a01
14 changed files with 1873 additions and 19 deletions
+108
View File
@@ -18,17 +18,125 @@ export namespace Pathspec {
}
export class Pathspec {
/**
*
*
* @static
* @param {*} m
* @param {number} pos
* @returns {DiffDelta}
*
* @memberof Pathspec
*/
static matchListDiffEntry(m: any, pos: number): DiffDelta;
/**
*
*
* @static
* @param {*} m
* @param {number} pos
* @returns {string}
*
* @memberof Pathspec
*/
static matchListEntry(m: any, pos: number): string;
/**
*
*
* @static
* @param {*} m
* @returns {number}
*
* @memberof Pathspec
*/
static matchListEntrycount(m: any): number;
/**
*
*
* @static
* @param {*} m
* @param {number} pos
* @returns {string}
*
* @memberof Pathspec
*/
static matchListFailedEntry(m: any, pos: number): string;
/**
*
*
* @static
* @param {*} m
* @returns {number}
*
* @memberof Pathspec
*/
static matchListFailedEntrycount(m: any): number;
/**
*
*
* @static
* @param {Strarray} pathspec
* @returns {Pathspec}
*
* @memberof Pathspec
*/
static create(pathspec: Strarray): Pathspec;
/**
*
*
*
* @memberof Pathspec
*/
free(): void;
/**
*
*
* @param {Diff} diff
* @param {number} flags
* @returns {Promise<any>}
*
* @memberof Pathspec
*/
matchDiff(diff: Diff, flags: number): Promise<any>;
/**
*
*
* @param {Index} index
* @param {number} flags
* @returns {Promise<any>}
*
* @memberof Pathspec
*/
matchIndex(index: Index, flags: number): Promise<any>;
/**
*
*
* @param {Tree} tree
* @param {number} flags
* @returns {Promise<any>}
*
* @memberof Pathspec
*/
matchTree(tree: Tree, flags: number): Promise<any>;
/**
*
*
* @param {Repository} repo
* @param {number} flags
* @returns {Promise<any>}
*
* @memberof Pathspec
*/
matchWorkdir(repo: Repository, flags: number): Promise<any>;
/**
*
*
* @param {number} flags
* @param {string} path
* @returns {number}
*
* @memberof Pathspec
*/
matchesPath(flags: number, path: string): number;
}