Added more documentation

types/nodegit/submodule.d.ts

@@ -45,37 +45,308 @@ export namespace Submodule {
 }
 
 export class Submodule {
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} url
+     * @param {string} path
+     * @param {number} use_gitlink
+     * @returns {Promise<Submodule>}
+     *
+     * @memberof Submodule
+     */
     static addSetup(repo: Repository, url: string, path: string, use_gitlink: number): Promise<Submodule>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {Function} callback
+     * @param {*} payload
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     static foreach(repo: Repository, callback: Function, payload: any): Promise<number>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @returns {Promise<Submodule>}
+     *
+     * @memberof Submodule
+     */
     static lookup(repo: Repository, name: string): Promise<Submodule>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} url
+     * @returns {Promise<Buf>}
+     *
+     * @memberof Submodule
+     */
     static resolveUrl(repo: Repository, url: string): Promise<Buf>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @param {string} branch
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     static setBranch(repo: Repository, name: string, branch: string): number;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @param {number} fetch_recurse_submodules
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     static setFetchRecurseSubmodules(repo: Repository, name: string, fetch_recurse_submodules: number): number;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @param {number} ignore
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     static setIgnore(repo: Repository, name: string, ignore: number): Promise<number>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @param {number} update
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     static setUpdate(repo: Repository, name: string, update: number): Promise<number>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @param {string} url
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     static setUrl(repo: Repository, name: string, url: string): Promise<number>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} name
+     * @param {number} ignore
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     static status(repo: Repository, name: string, ignore: number): Promise<number>;
+    /**
+     *
+     *
+     * @static
+     * @param {SubmoduleUpdateOptions} opts
+     * @param {number} version
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     static updateInitOptions(opts: SubmoduleUpdateOptions, version: number): number;
 
+    /**
+     *
+     *
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     addFinalize(): Promise<number>;
+    /**
+     *
+     *
+     * @param {number} write_index
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     addToIndex(write_index: number): Promise<number>;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Submodule
+     */
     branch(): string;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     fetchRecurseSubmodules(): number;
+    /**
+     *
+     *
+     *
+     * @memberof Submodule
+     */
     free(): void;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Submodule
+     */
     headId(): Oid;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     ignore(): number;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Submodule
+     */
     indexId(): Oid;
+    /**
+     *
+     *
+     * @param {number} overwrite
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     init(overwrite: number): Promise<number>;
+    /**
+     *
+     *
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     location(): Promise<number>;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Submodule
+     */
     name(): string;
+    /**
+     *
+     *
+     * @returns {Promise<Repository>}
+     *
+     * @memberof Submodule
+     */
     open(): Promise<Repository>;
+    /**
+     *
+     *
+     * @returns {Repository}
+     *
+     * @memberof Submodule
+     */
     owner(): Repository;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Submodule
+     */
     path(): string;
+    /**
+     *
+     *
+     * @param {number} force
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     reload(force: number): number;
+    /**
+     *
+     *
+     * @param {number} use_gitlink
+     * @returns {Promise<Repository>}
+     *
+     * @memberof Submodule
+     */
     repoInit(use_gitlink: number): Promise<Repository>;
+    /**
+     *
+     *
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     sync(): Promise<number>;
+    /**
+     * Updates a submodule
+     *
+     * @param {number} init
+     * @param {SubmoduleUpdateOptions} options
+     * @returns {Promise<number>}
+     *
+     * @memberof Submodule
+     */
     update(init: number, options: SubmoduleUpdateOptions): Promise<number>;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Submodule
+     */
     updateStrategy(): number;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Submodule
+     */
     url(): string;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Submodule
+     */
     wdId(): Oid;
 }