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;
 }

types/nodegit/tag.d.ts

@@ -5,23 +5,191 @@ import { Signature } from './signature';
 import { Strarray } from './str-array';
 
 export class Tag {
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} tag_name
+     * @param {Object} target
+     * @param {Signature} tagger
+     * @param {string} message
+     * @returns {Promise<Oid>}
+     *
+     * @memberof Tag
+     */
     static annotationCreate(repo: Repository, tag_name: string, target: Object, tagger: Signature, message: string): Promise<Oid>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} tag_name
+     * @param {Object} target
+     * @param {Signature} tagger
+     * @param {string} message
+     * @param {number} force
+     * @returns {Promise<Oid>}
+     *
+     * @memberof Tag
+     */
     static create(repo: Repository, tag_name: string, target: Object, tagger: Signature, message: string, force: number): Promise<Oid>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} tag_name
+     * @param {Object} target
+     * @param {number} force
+     * @returns {Promise<Oid>}
+     *
+     * @memberof Tag
+     */
     static createLightweight(repo: Repository, tag_name: string, target: Object, force: number): Promise<Oid>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {string} tag_name
+     * @returns {Promise<number>}
+     *
+     * @memberof Tag
+     */
     static delete(repo: Repository, tag_name: string): Promise<number>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @returns {Promise<any[]>}
+     *
+     * @memberof Tag
+     */
     static list(repo: Repository): Promise<any[]>;
+    /**
+     *
+     *
+     * @static
+     * @param {Strarray} tag_names
+     * @param {string} pattern
+     * @param {Repository} repo
+     * @returns {number}
+     *
+     * @memberof Tag
+     */
     static listMatch(tag_names: Strarray, pattern: string, repo: Repository): number;
+    /**
+     * Retrieves the tag pointed to by the oid
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {(string | Oid | Tag)} id
+     * @returns {Promise<Tag>}
+     *
+     * @memberof Tag
+     */
     static lookup(repo: Repository, id: string | Oid | Tag): Promise<Tag>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {Oid} id
+     * @param {number} len
+     * @returns {Promise<Tag>}
+     *
+     * @memberof Tag
+     */
     static lookupPrefix(repo: Repository, id: Oid, len: number): Promise<Tag>;
 
+    /**
+     *
+     *
+     * @returns {Promise<Tag>}
+     *
+     * @memberof Tag
+     */
+    dup(): Promise<Tag>;
+    /**
+     *
+     *
+     *
+     * @memberof Tag
+     */
     free(): void;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Tag
+     */
     id(): Oid;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Tag
+     */
     message(): string;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof Tag
+     */
     name(): string;
+    /**
+     *
+     *
+     * @returns {Repository}
+     *
+     * @memberof Tag
+     */
     owner(): Repository;
-    peel(tag_target_out: Object): number;
+    /**
+     *
+     *
+     * @param {Object} tagTargetOut
+     * @returns {number}
+     *
+     * @memberof Tag
+     */
+    peel(tagTargetOut: Object): number;
+    /**
+     *
+     *
+     * @returns {Signature}
+     *
+     * @memberof Tag
+     */
     tagger(): Signature;
+    /**
+     *
+     *
+     * @returns {Object}
+     *
+     * @memberof Tag
+     */
     target(): Object;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Tag
+     */
     targetId(): Oid;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Tag
+     */
     targetType(): number;
 }

types/nodegit/time.d.ts

@@ -1,4 +1,16 @@
 export class Time {
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof Time
+     */
     time: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof Time
+     */
     offset: number;
 }

types/nodegit/transfer-progress.d.ts

@@ -1,9 +1,51 @@
 export class TransferProgress {
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     totalObjects: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     indexedObjects: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     receivedObjects: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     localObjects: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     totalDeltas: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     indexedDeltas: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof TransferProgress
+     */
     receivedBytes: number;
 }

types/nodegit/transport.d.ts

@@ -1,5 +1,6 @@
 import { Remote } from './remote';
 import { Strarray } from './str-array';
+import { Cert } from './cert';
 
 export namespace Transport {
     const enum FLAGS {
@@ -8,7 +9,45 @@ export namespace Transport {
 }
 
 export class Transport {
+    /**
+     * å
+     *
+     * @static
+     * @param {Remote} owner
+     * @param {Strarray} payload
+     * @returns {Promise<Transport>}
+     *
+     * @memberof Transport
+     */
     static sshWithPaths(owner: Remote, payload: Strarray): Promise<Transport>;
+    /**
+     *
+     *
+     * @static
+     * @param {string} prefix
+     * @returns {number}
+     *
+     * @memberof Transport
+     */
     static unregister(prefix: string): number;
+    /**
+     *
+     *
+     * @param {number} version
+     * @returns {number}
+     *
+     * @memberof Transport
+     */
     init(version: number): number;
+    /**
+     *
+     *
+     * @param {Cert} cert
+     * @param {number} valid
+     * @param {string} hostName
+     * @returns {number}
+     *
+     * @memberof Transport
+     */
+    smartCertificateCheck(cert: Cert, valid: number, hostName: string): number;
 }

types/nodegit/tree-builder.d.ts

@@ -4,13 +4,75 @@ import { Tree } from './tree';
 import { TreeEntry } from './tree-entry';
 
 export class Treebuilder {
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {Tree} source
+     * @returns {Promise<Treebuilder>}
+     *
+     * @memberof Treebuilder
+     */
     static create(repo: Repository, source: Tree): Promise<Treebuilder>;
 
+    /**
+     *
+     *
+     *
+     * @memberof Treebuilder
+     */
     clear(): void;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Treebuilder
+     */
     entrycount(): number;
+    /**
+     *
+     *
+     *
+     * @memberof Treebuilder
+     */
     free(): void;
+    /**
+     *
+     *
+     * @param {string} filename
+     * @returns {TreeEntry}
+     *
+     * @memberof Treebuilder
+     */
     get(filename: string): TreeEntry;
+    /**
+     *
+     *
+     * @param {string} filename
+     * @param {Oid} id
+     * @param {number} filemode
+     * @returns {Promise<TreeEntry>}
+     *
+     * @memberof Treebuilder
+     */
     insert(filename: string, id: Oid, filemode: number): Promise<TreeEntry>;
+    /**
+     *
+     *
+     * @param {string} filename
+     * @returns {number}
+     *
+     * @memberof Treebuilder
+     */
     remove(filename: string): number;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Treebuilder
+     */
     write(): Oid;
 }

types/nodegit/tree-entry.d.ts

@@ -1,6 +1,7 @@
 import { Tree } from './tree';
 import { Oid } from './oid';
 import { Blob } from './blob';
+import { Repository } from './repository';
 
 export namespace TreeEntry {
     const enum FILEMODE {
@@ -14,17 +15,148 @@ export namespace TreeEntry {
 }
 
 export class TreeEntry {
-    isFile(): boolean;
-    isTree(): boolean;
-    isDirectory(): boolean;
-    isBlob(): boolean;
-    sha(): string;
-    getTree(): Promise<Tree>;
+    /**
+     *
+     *
+     * @returns {TreeEntry.FILEMODE}
+     *
+     * @memberof TreeEntry
+     */
+    filemode(): TreeEntry.FILEMODE;
+    /**
+     *
+     *
+     * @returns {TreeEntry.FILEMODE}
+     *
+     * @memberof TreeEntry
+     */
+    filemodeRaw(): TreeEntry.FILEMODE;
+    /**
+     *
+     *
+     *
+     * @memberof TreeEntry
+     */
+    free(): void;
+    /**
+     *
+     *
+     * @returns {Promise<Blob>}
+     *
+     * @memberof TreeEntry
+     */
     getBlob(): Promise<Blob>;
+    /**
+     *
+     *
+     * @returns {Promise<Tree>}
+     *
+     * @memberof TreeEntry
+     */
+    getTree(): Promise<Tree>;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof TreeEntry
+     */
+    id(): Oid;
+    /**
+     *
+     *
+     * @returns {boolean}
+     *
+     * @memberof TreeEntry
+     */
+    isBlob(): boolean;
+    /**
+     *
+     *
+     * @returns {boolean}
+     *
+     * @memberof TreeEntry
+     */
+    isFile(): boolean;
+    /**
+     *
+     *
+     * @returns {boolean}
+     *
+     * @memberof TreeEntry
+     */
+    isTree(): boolean;
+    /**
+     *
+     *
+     * @returns {boolean}
+     *
+     * @memberof TreeEntry
+     */
+    isDirectory(): boolean;
+    /**
+     *
+     *
+     * @returns {boolean}
+     *
+     * @memberof TreeEntry
+     */
+    isSubmodule(): boolean;
+    /**
+     * Retrieve the SHA for this TreeEntry.
+     *
+     * @returns {string}
+     *
+     * @memberof TreeEntry
+     */
+    sha(): string;
+    /**
+     *
+     *
+     * @returns {string}
+     *
+     * @memberof TreeEntry
+     */
+    name(): string;
+    /**
+     * Retrieve the SHA for this TreeEntry. Alias for sha
+     *
+     * @returns {string}
+     *
+     * @memberof TreeEntry
+     */
+    oid(): string;
+    /**
+     * Returns the path for this entry.
+     *
+     * @returns {string}
+     *
+     * @memberof TreeEntry
+     */
     path(): string;
+    /**
+     * Alias for path
+     *
+     * @returns {string}
+     *
+     * @memberof TreeEntry
+     */
     toString(): string;
-    attr: number;
-    oid: Oid;
-    filenameLen: number;
-    filename: string;
+    /**
+     *
+     *
+     * @param {Repository} repo
+     * @returns {Object}
+     *
+     * @memberof TreeEntry
+     */
+    toObject(repo: Repository): Object;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof TreeEntry
+     */
+    type(): number;
 }

types/nodegit/tree.d.ts

@@ -13,32 +13,219 @@ export namespace Tree {
 }
 
 export class Tree {
-    static entryCmp(e1: TreeEntry, e2: TreeEntry): number;
+    /**
+     *
+     *
+     * @static
+     * @param {TreeEntry} tree1
+     * @param {TreeEntry} tree2
+     * @returns {number}
+     *
+     * @memberof Tree
+     */
+    static entryCmp(tree1: TreeEntry, tree2: TreeEntry): number;
+    /**
+     *
+     *
+     * @static
+     * @param {TreeEntry} dest
+     * @param {TreeEntry} source
+     * @returns {number}
+     *
+     * @memberof Tree
+     */
     static entryDup(dest: TreeEntry, source: TreeEntry): number;
-    static entryFilemode(entry: TreeEntry): number;
-    static entryFilemodeRaw(entry: TreeEntry): number;
-    static entryFree(entry: TreeEntry): void;
-    static entryId(entry: TreeEntry): Oid;
-    static entryName(entry: TreeEntry): string;
-    static entryToObject(object_out: Object, repo: Repository, entry: TreeEntry): number;
-    static entryType(entry: TreeEntry): number;
+    /**
+     * Retrieves the tree pointed to by the oid
+     *
+     * @static
+     * @returns {Promise<Tree>}
+     *
+     * @memberof Tree
+     */
+    static lookup(): Promise<Tree>;
+    /**
+     *
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {Oid} id
+     * @param {number} len
+     * @returns {Promise<Tree>}
+     *
+     * @memberof Tree
+     */
+    static lookupPrefix(repo: Repository, id: Oid, len: number): Promise<Tree>;
+
+    /**
+     * Retrieves the tree pointed to by the oid
+     *
+     * @static
+     * @param {Repository} repo
+     * @param {(string | Oid | Tree)} id
+     * @param {Function} callback
+     * @returns {Promise<Tree>}
+     *
+     * @memberof Tree
+     */
     static lookup(repo: Repository, id: string | Oid | Tree, callback: Function): Promise<Tree>;
     static lookupPrefix(repo: Repository, id: Oid, len: number): Promise<Tree>;
 
+    /**
+     *
+     *
+     * @param {Oid} id
+     * @returns {TreeEntry}
+     *
+     * @memberof Tree
+     */
     entryById(id: Oid): TreeEntry;
+    /**
+     *
+     *
+     * @param {number} idx
+     * @returns {TreeEntry}
+     *
+     * @memberof Tree
+     */
     _entryByIndex(idx: number): TreeEntry;
+    /**
+     * Get an entry by name; if the tree is a directory, the name is the filename.
+     *
+     * @param {string} name
+     * @returns {TreeEntry}
+     *
+     * @memberof Tree
+     */
     entryByName(name: string): TreeEntry;
+    /**
+     *
+     *
+     * @param {string} filename
+     * @returns {TreeEntry}
+     *
+     * @memberof Tree
+     */
+    _entryByName(filename: string): TreeEntry;
+    /**
+     *
+     *
+     * @param {string} path
+     * @returns {Promise<TreeEntry>}
+     *
+     * @memberof Tree
+     */
     entryByPath(path: string): Promise<TreeEntry>;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Tree
+     */
     entryCount(): number;
+    /**
+     *
+     *
+     *
+     * @memberof Tree
+     */
     free(): void;
+    /**
+     *
+     *
+     * @returns {Oid}
+     *
+     * @memberof Tree
+     */
     id(): Oid;
+    /**
+     *
+     *
+     * @returns {Repository}
+     *
+     * @memberof Tree
+     */
     owner(): Repository;
+    /**
+     * Diff two trees
+     *
+     * @param {Tree} tree
+     * @param {Function} callback
+     * @returns {Promise<DiffFile[]>}
+     *
+     * @memberof Tree
+     */
     diff(tree: Tree, callback: Function): Promise<DiffFile[]>;
+    /**
+     * Diff two trees with options
+     *
+     * @param {Tree} tree
+     * @param {Object} options
+     * @param {Function} callback
+     * @returns {Promise<DiffFile[]>}
+     *
+     * @memberof Tree
+     */
     diffWithOptions(tree: Tree, options: Object, callback: Function): Promise<DiffFile[]>;
+    /**
+     * Get an entry at the ith position.
+     *
+     * @param {number} i
+     * @returns {TreeEntry}
+     *
+     * @memberof Tree
+     */
     entryByIndex(i: number): TreeEntry;
+    /**
+     * Get an entry at a path. Unlike by name, this takes a fully qualified path, like /foo/bar/baz.javascript
+     *
+     * @param {string} filePath
+     * @returns {TreeEntry}
+     *
+     * @memberof Tree
+     */
     getEntry(filePath: string): TreeEntry;
+    /**
+     * Return an array of the entries in this tree (excluding its children).
+     *
+     * @returns {TreeEntry[]}
+     *
+     * @memberof Tree
+     */
     entries(): TreeEntry[];
+    /**
+     * Recursively walk the tree in breadth-first order. Fires an event for each entry.
+     *
+     * @param {boolean} [blobsOnly]
+     * @returns {NodeJS.EventEmitter}
+     *
+     * @memberof Tree
+     */
     walk(blobsOnly?: boolean): NodeJS.EventEmitter;
+    /**
+     * Return the path of this tree, like /lib/foo/bar
+     *
+     * @returns {string}
+     *
+     * @memberof Tree
+     */
     path(): string;
+    /**
+     * Make builder. This is helpful for modifying trees.
+     *
+     * @returns {Treebuilder}
+     *
+     * @memberof Tree
+     */
     builder(): Treebuilder;
+    /**
+     *
+     *
+     * @returns {Promise<Tree>}
+     *
+     * @memberof Tree
+     */
+    dup(): Promise<Tree>;
+    createUpdated(repo: Repository, nUpdates: number, updates: TreeUpdate): Promise<Oid>;
 }