From 20499792a7a8215cb4922291466683fed97cf173 Mon Sep 17 00:00:00 2001
From: Dolan <dolan_miu@hotmail.com>
Date: Thu, 8 Jun 2017 02:13:24 +0100
Subject: [PATCH] Added documentation to Blame

---
 types/nodegit/blame-hunk.d.ts    | 48 ++++++++++++++++++++++++
 types/nodegit/blame-options.d.ts | 44 +++++++++++++++++++++-
 types/nodegit/blame.d.ts         | 63 +++++++++++++++++++++++++++++++-
 types/nodegit/nodegit-tests.ts   |  2 +
 4 files changed, 154 insertions(+), 3 deletions(-)

diff --git a/types/nodegit/blame-hunk.d.ts b/types/nodegit/blame-hunk.d.ts
index 58ab8e7191..83dd1cc410 100644
--- a/types/nodegit/blame-hunk.d.ts
+++ b/types/nodegit/blame-hunk.d.ts
@@ -2,12 +2,60 @@ import { Oid } from './oid';
 import { Signature } from './signature';
 
 export class BlameHunk {
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameHunk
+     */
     linesInHunk: number;
+    /**
+     *
+     *
+     * @type {Oid}
+     * @memberof BlameHunk
+     */
     finalCommitId: Oid;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameHunk
+     */
     finalStartLineNumber: number;
+    /**
+     *
+     *
+     * @type {Signature}
+     * @memberof BlameHunk
+     */
     finalSignature: Signature;
+    /**
+     *
+     *
+     * @type {Oid}
+     * @memberof BlameHunk
+     */
     origCommitId: Oid;
+    /**
+     *
+     *
+     * @type {string}
+     * @memberof BlameHunk
+     */
     origPath: string;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameHunk
+     */
     origStartLineNumber: number;
+    /**
+     *
+     *
+     * @type {Signature}
+     * @memberof BlameHunk
+     */
     origSignature: Signature;
 }
diff --git a/types/nodegit/blame-options.d.ts b/types/nodegit/blame-options.d.ts
index ca5f1f50df..eac4c2f4f0 100644
--- a/types/nodegit/blame-options.d.ts
+++ b/types/nodegit/blame-options.d.ts
@@ -1,11 +1,53 @@
 import {Oid} from './oid';
 
-export interface BlameOptions {
+export class BlameOptions {
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameOptions
+     */
     version: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameOptions
+     */
     flags: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameOptions
+     */
     minMatchCharacters: number;
+    /**
+     *
+     *
+     * @type {Oid}
+     * @memberof BlameOptions
+     */
     newestCommit: Oid;
+    /**
+     *
+     *
+     * @type {Oid}
+     * @memberof BlameOptions
+     */
     oldestCommit: Oid;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameOptions
+     */
     minLine: number;
+    /**
+     *
+     *
+     * @type {number}
+     * @memberof BlameOptions
+     */
     maxLine: number;
 }
diff --git a/types/nodegit/blame.d.ts b/types/nodegit/blame.d.ts
index e5b5d90ec8..c6efdc133b 100644
--- a/types/nodegit/blame.d.ts
+++ b/types/nodegit/blame.d.ts
@@ -14,12 +14,71 @@ export namespace Blame {
 }
 
 export class Blame {
+    /**
+     * Retrieve the blame of a file
+     *
+     * @static
+     * @param {Repository} repo - Repository that contains the file
+     * @param {string} path - to the file to get the blame of
+     * @param {BlameOptions} [options] - Options for the blame
+     * @returns {Blame}
+     *
+     * @memberof Blame
+     */
     static file(repo: Repository, path: string, options?: BlameOptions): Blame;
+    /**
+     *
+     *
+     * @static
+     * @param {BlameOptions} opts - The git_blame_options struct to initialize
+     * @param {number} version - Version of struct; pass GIT_BLAME_OPTIONS_VERSION
+     * @returns {number}
+     *
+     * @memberof Blame
+     */
     static initOptions(opts: BlameOptions, version: number): number;
 
-    buffer(buffer: string, buffer_len: number): Promise<Blame>;
+    /**
+     *
+     *
+     * @param {string} buffer
+     * @param {number} bufferLen
+     * @returns {Promise<Blame>}
+     *
+     * @memberof Blame
+     */
+    buffer(buffer: string, bufferLen: number): Promise<Blame>;
+    /**
+     *
+     *
+     *
+     * @memberof Blame
+     */
     free(): void;
+    /**
+     *
+     *
+     * @param {number} index
+     * @returns {BlameHunk} - the hunk at the given index, or NULL on error
+     *
+     * @memberof Blame
+     */
     getHunkByIndex(index: number): BlameHunk;
-    getHunkByLine(lineno: number): BlameHunk;
+    /**
+     *
+     *
+     * @param {number} lineNo
+     * @returns {BlameHunk} - 	the hunk that contains the given line, or NULL on error
+     *
+     * @memberof Blame
+     */
+    getHunkByLine(lineNo: number): BlameHunk;
+    /**
+     *
+     *
+     * @returns {number}
+     *
+     * @memberof Blame
+     */
     getHunkCount(): number;
 }
diff --git a/types/nodegit/nodegit-tests.ts b/types/nodegit/nodegit-tests.ts
index 370369eed4..e9bceb601e 100644
--- a/types/nodegit/nodegit-tests.ts
+++ b/types/nodegit/nodegit-tests.ts
@@ -45,3 +45,5 @@ Git.Attr.get(repo, 1, "path", "name").then((string) => {
 let array = Git.Attr.getMany(repo, 1, "path", 1, "names");
 
 result = Git.Attr.value("attr");
+
+const blameOptions = new Git.BlameOptions();