aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java
diff options
context:
space:
mode:
authorMatthias Sohn <matthias.sohn@sap.com>2017-12-19 23:06:46 +0100
committerMatthias Sohn <matthias.sohn@sap.com>2017-12-20 22:10:11 +0100
commitfdbaa25db9a0c9c5190d96388734e7cc3e6a1e75 (patch)
treeb1fbb03eab5881c07576e1d000be04a0696d3b66 /org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java
parentc4207c5fbe666c7db0455cc17023c0a15feaecbe (diff)
downloadjgit-fdbaa25db9a0c9c5190d96388734e7cc3e6a1e75.tar.gz
jgit-fdbaa25db9a0c9c5190d96388734e7cc3e6a1e75.zip
Fix javadoc in org.eclipse.jgit util packages
Change-Id: Ia655f45153bcf1d422ffffce6dcf914847e14c4c Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java24
1 files changed, 16 insertions, 8 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java
index f1f6053e3b..c8e6645f57 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/ChangeIdUtil.java
@@ -82,9 +82,11 @@ public class ChangeIdUtil {
* @param firstParentId
* parent id of previous commit or null
* @param author
- * the {@link PersonIdent} for the presumed author and time
+ * the {@link org.eclipse.jgit.lib.PersonIdent} for the presumed
+ * author and time
* @param committer
- * the {@link PersonIdent} for the presumed committer and time
+ * the {@link org.eclipse.jgit.lib.PersonIdent} for the presumed
+ * committer and time
* @param message
* The commit message
* @return the change id SHA1 string (without the 'I') or null if the
@@ -138,7 +140,9 @@ public class ChangeIdUtil {
* line.
*
* @param message
+ * a message.
* @param changeId
+ * a Change-Id.
* @return a commit message with an inserted Change-Id line
*/
public static String insertId(String message, ObjectId changeId) {
@@ -148,18 +152,21 @@ public class ChangeIdUtil {
/**
* Find the right place to insert a Change-Id and return it.
* <p>
- * If no Change-Id is found the Change-Id is inserted before
- * the first footer line but after a Bug line.
+ * If no Change-Id is found the Change-Id is inserted before the first
+ * footer line but after a Bug line.
*
- * If Change-Id is found and replaceExisting is set to false,
- * the message is unchanged.
+ * If Change-Id is found and replaceExisting is set to false, the message is
+ * unchanged.
*
- * If Change-Id is found and replaceExisting is set to true,
- * the Change-Id is replaced with {@code changeId}.
+ * If Change-Id is found and replaceExisting is set to true, the Change-Id
+ * is replaced with {@code changeId}.
*
* @param message
+ * a message.
* @param changeId
+ * a Change-Id.
* @param replaceExisting
+ * a boolean.
* @return a commit message with an inserted Change-Id line
*/
public static String insertId(String message, ObjectId changeId,
@@ -219,6 +226,7 @@ public class ChangeIdUtil {
* only lines matching {@code footerPattern}.
*
* @param message
+ * a message.
* @param delimiter
* the line delimiter, like "\n" or "\r\n", needed to find the
* footer