Make BlameGenerator comments more clearrefs/changes/38/7238/4

The file location of the constructor for BlameGenerator
did not specify where the path should be relative from.

Fix BlameGenerator comments based on suggestions by Robin Stocker.

Change-Id: I3d79db2d2ba4961835fe664ae6178e0bfc97b910

1 files changed, 6 insertions, 4 deletions

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameGenerator.java b/org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameGenerator.java
index ebb5897..cea719a 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameGenerator.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameGenerator.java
@@ -76,7 +76,7 @@ import org.eclipse.jgit.treewalk.filter.PathFilter;
 import org.eclipse.jgit.treewalk.filter.TreeFilter;
 
 /**
- * Generate author information for lines based on introduction to the file.
+ * Generate author information for lines based on a provided file.
  * <p>
  * Applications that want a simple one-shot computation of blame for a file
  * should use {@link #computeBlameResult()} to prepare the entire result in one
@@ -144,12 +144,14 @@ public class BlameGenerator {
 	private Candidate currentSource;
 
 	/**
-	 * Create a blame generator for the repository and path
-	 *
+	 * Create a blame generator for the repository and path (relative to
+	 * repository)
+	 * 
 	 * @param repository
 	 *            repository to access revision data from.
 	 * @param path
-	 *            initial path of the file to start scanning.
+	 *            initial path of the file to start scanning (relative to the
+	 *            repository).
 	 */
 	public BlameGenerator(Repository repository, String path) {
 		this.repository = repository;