aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/util
diff options
context:
space:
mode:
authorHan-Wen Nienhuys <hanwen@google.com>2018-05-14 17:21:39 +0200
committerJonathan Nieder <jrn@google.com>2018-05-14 17:42:03 -0700
commitf6873ffe522bbc3536969a3a3546bf9a819b92bf (patch)
tree62b996b3552476196f020e62bbb77d2aad3a22d2 /org.eclipse.jgit/src/org/eclipse/jgit/util
parent7d9246f1636ca35f2db252581769d36c4c80e309 (diff)
downloadjgit-f6873ffe522bbc3536969a3a3546bf9a819b92bf.tar.gz
jgit-f6873ffe522bbc3536969a3a3546bf9a819b92bf.zip
Fixup javadoc and formatting in RawText and RawParseUtils
Change-Id: I9d6002941a33ec204d29e4fd920dde965387bb24 Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/util')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java26
1 files changed, 15 insertions, 11 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java b/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java
index 490cdd3cd1..26fc9d80c5 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/util/RawParseUtils.java
@@ -633,8 +633,9 @@ public final class RawParseUtils {
* line 1.
* @param end
* 1 past the end of the content within <code>buf</code>.
- * @return a line map indexing the start position of each line, or a map representing the entire
- * array as a single line if a '\0' is found.
+ * @return a line map indicating the starting position of each line, or a
+ * map representing the entire buffer as a single line if
+ * <code>buf</code> contains a NUL byte.
*/
public static final IntList lineMap(final byte[] buf, int ptr, int end) {
IntList map = lineMapOrNull(buf, ptr, end);
@@ -648,19 +649,22 @@ public final class RawParseUtils {
}
/**
- * Like {@link #lineMap(byte[], int, int)} but throw {@link BinaryBlobException} if a null char
- * is encountered.
- * @param buf buffer to scan.
- * @param ptr position within the buffer corresponding to the first byte of
+ * Like {@link #lineMap(byte[], int, int)} but throw
+ * {@link BinaryBlobException} if a NUL byte is encountered.
+ *
+ * @param buf
+ * buffer to scan.
+ * @param ptr
+ * position within the buffer corresponding to the first byte of
* line 1.
- * @param end 1 past the end of the content within <code>buf</code>.
- * @return a line map indexing the start position of each line, or a map representing the entire
- * array as a single line if a '\0' is found.
+ * @param end
+ * 1 past the end of the content within <code>buf</code>.
+ * @return a line map indicating the starting position of each line.
* @throws BinaryBlobException
- *
+ * if a NUL byte is found.
* @since 5.0
*/
- public static final IntList lineMapOrBinary(final byte[] buf, int ptr, int end)
+ public static final IntList lineMapOrBinary(byte[] buf, int ptr, int end)
throws BinaryBlobException {
IntList map = lineMapOrNull(buf, ptr, end);
if (map == null) {