aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick Carlson2012-08-15 13:23:06 -0400
committerPatrick Carlson2012-08-17 10:57:19 -0400
commit9a979a36814db0dd38229f3eca8be7fbd54ea3bd (patch)
tree41e1cd6a4ec720885fd127d301868669a0d5556e
parent02113f7411df6d680aa520803ac8c63009696c3a (diff)
downloadjgit-9a979a36814db0dd38229f3eca8be7fbd54ea3bd.zip
jgit-9a979a36814db0dd38229f3eca8be7fbd54ea3bd.tar.gz
jgit-9a979a36814db0dd38229f3eca8be7fbd54ea3bd.tar.xz
Make BlameGenerator comments more clear
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
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameGenerator.java10
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;