Added documentation

This commit is contained in:
Dolan
2017-06-08 02:07:21 +01:00
parent 98e2a4a83f
commit 73c4f21d97

View File

@@ -10,9 +10,62 @@ export namespace Attr {
}
export class Attr {
/**
*
*
* @static
* @param {Repository} repo
* @param {string} name
* @param {string} values
* @returns {number}
*
* @memberof Attr
*/
static addMacro(repo: Repository, name: string, values: string): number;
/**
*
*
* @static
* @param {Repository} repo
*
* @memberof Attr
*/
static cacheFlush(repo: Repository): void;
/**
*
*
* @static
* @param {Repository} repo - The repository containing the path.
* @param {number} flags - A combination of GIT_ATTR_CHECK... flags.
* @param {string} path - The path to check for attributes. Relative paths are interpreted relative to the repo root. The file does not have to exist, but if it does not, then it will be treated as a plain file (not a directory).
* @param {string} name - The name of the attribute to look up.
* @returns {Promise<string>} - Output of the value of the attribute. Use the GIT_ATTR_...
*
* @memberof Attr
*/
static get(repo: Repository, flags: number, path: string, name: string): Promise<string>;
/**
*
*
* @static
* @param {Repository} repo - The repository containing the path.
* @param {number} flags - A combination of GIT_ATTR_CHECK... flags.
* @param {string} path - The path to check for attributes. Relative paths are interpreted relative to the repo root. The file does not have to exist, but if it does not, then it will be treated as a plain file (not a directory).
* @param {number} numAttr - The number of attributes being looked up
* @param {string} names - An array of num_attr strings containing attribute names.
* @returns {any[]}
*
* @memberof Attr
*/
static getMany(repo: Repository, flags: number, path: string, numAttr: number, names: string): any[];
/**
*
*
* @static
* @param {string} attr - The attribute
* @returns {number}- the value type for the attribute
*
* @memberof Attr
*/
static value(attr: string): number;
}