motiejus
/
jgit
1
Fork 0
Code Releases Activity

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
This commit is contained in:
Patrick Carlson 2012-08-15 12:23:06 -05:00
parent 02113f7411
commit 9a979a3681
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
org.eclipse.jgit/src/org/eclipse/jgit/blame/BlameGenerator.java
View File

@ -76,7 +76,7 @@
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;