You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pl...@apache.org on 2015/08/24 05:00:34 UTC
directory-kerby git commit: Fix javadoc of kerby-asn1,
kerby-util and kerby-config.
Repository: directory-kerby
Updated Branches:
refs/heads/master a2bdc218b -> 4a60163e3
Fix javadoc of kerby-asn1, kerby-util and kerby-config.
Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/4a60163e
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/4a60163e
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/4a60163e
Branch: refs/heads/master
Commit: 4a60163e3c0d277c6110d437802f06272d12ad05
Parents: a2bdc21
Author: plusplusjiajia <ji...@intel.com>
Authored: Mon Aug 24 11:05:58 2015 +0800
Committer: plusplusjiajia <ji...@intel.com>
Committed: Mon Aug 24 11:05:58 2015 +0800
----------------------------------------------------------------------
.../java/org/apache/kerby/asn1/Asn1Factory.java | 4 +-
.../org/apache/kerby/asn1/Asn1InputBuffer.java | 11 +++---
.../org/apache/kerby/asn1/EncodingOption.java | 2 +-
.../java/org/apache/kerby/asn1/TagClass.java | 4 +-
.../org/apache/kerby/asn1/TaggingOption.java | 16 ++++----
.../kerby/asn1/type/AbstractAsn1Type.java | 21 +++++-----
.../org/apache/kerby/asn1/type/Asn1Boolean.java | 2 +-
.../kerby/asn1/type/Asn1GeneralizedTime.java | 1 +
.../org/apache/kerby/asn1/type/Asn1Simple.java | 15 ++++----
.../org/apache/kerby/asn1/type/Asn1Type.java | 32 ++++++++--------
.../java/org/apache/kerby/config/Config.java | 40 ++++++++++----------
.../main/java/org/apache/kerby/KOptions.java | 4 +-
.../main/java/org/apache/kerby/util/Base64.java | 10 ++---
.../apache/kerby/util/Base64InputStream.java | 4 +-
.../apache/kerby/util/Base64OutputStream.java | 4 +-
.../java/org/apache/kerby/util/HexUtil.java | 4 ++
.../main/java/org/apache/kerby/util/IOUtil.java | 12 +++---
17 files changed, 96 insertions(+), 90 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1Factory.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1Factory.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1Factory.java
index ea4eca8..7610751 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1Factory.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1Factory.java
@@ -30,7 +30,7 @@ public class Asn1Factory {
/**
* Create an ASN1 type with specified tag number
- * @param tagNo
+ * @param tagNo The tag number
* @return ASN1 type
*/
public static Asn1Type create(int tagNo) {
@@ -43,7 +43,7 @@ public class Asn1Factory {
/**
* Create an ASN1 type with specified tag
- * @param tagNo
+ * @param tagNo The tag number
* @return ASN1 type
*/
public static Asn1Type create(UniversalTag tagNo) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
index 1cda697..2441749 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
@@ -36,7 +36,7 @@ public class Asn1InputBuffer {
/**
* Constructor with bytes.
- * @param bytes
+ * @param bytes The bytes
*/
public Asn1InputBuffer(byte[] bytes) {
this(new LimitedByteBuffer(bytes));
@@ -44,7 +44,7 @@ public class Asn1InputBuffer {
/**
* Constructor with a ByteBuffer.
- * @param byteBuffer
+ * @param byteBuffer The byte buffer
*/
public Asn1InputBuffer(ByteBuffer byteBuffer) {
this(new LimitedByteBuffer(byteBuffer));
@@ -52,7 +52,7 @@ public class Asn1InputBuffer {
/**
* Constructor with LimitedByteBuffer.
- * @param limitedByteBuffer
+ * @param limitedByteBuffer The limited byte buffer
*/
public Asn1InputBuffer(LimitedByteBuffer limitedByteBuffer) {
this.limitedBuffer = limitedByteBuffer;
@@ -81,9 +81,10 @@ public class Asn1InputBuffer {
}
/**
+ * Read from bytes.
*
- * @param bytes
- * @throws IOException
+ * @param bytes The bytes
+ * @throws IOException e
*/
public void readBytes(byte[] bytes) throws IOException {
limitedBuffer.readBytes(bytes);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
index 8205d45..d9627e0 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/EncodingOption.java
@@ -113,7 +113,7 @@ public class EncodingOption {
/**
* Tells if it's definitive length or not.
- * @return
+ * @return The boolean value
*/
public boolean isDefLen() {
return this.isDefLen;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/TagClass.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/TagClass.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/TagClass.java
index bac9db8..cbd02fc 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/TagClass.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/TagClass.java
@@ -69,7 +69,7 @@ public enum TagClass {
/**
* Converted from an integer
- * @param value
+ * @param value The int value of tag class
* @return tag class
*/
public static TagClass fromValue(int value) {
@@ -90,7 +90,7 @@ public enum TagClass {
/**
* Converted from a tag value, which contains tag class info.
- * @param tag
+ * @param tag The int value of tag class
* @return tag class
*/
public static TagClass fromTagFlags(int tag) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/TaggingOption.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/TaggingOption.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/TaggingOption.java
index 98b4c23..f72d3e9 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/TaggingOption.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/TaggingOption.java
@@ -29,7 +29,7 @@ public final class TaggingOption {
/**
* Create an implicit application specific tagging option with tagNo.
- * @param tagNo
+ * @param tagNo The tag number
* @return tagging option
*/
public static TaggingOption newImplicitAppSpecific(int tagNo) {
@@ -38,7 +38,7 @@ public final class TaggingOption {
/**
* Create an explicit application specific tagging option with tagNo.
- * @param tagNo
+ * @param tagNo The tag number
* @return tagging option
*/
public static TaggingOption newExplicitAppSpecific(int tagNo) {
@@ -47,7 +47,7 @@ public final class TaggingOption {
/**
* Create an implicit context specific tagging option with tagNo.
- * @param tagNo
+ * @param tagNo The tag number
* @return tagging option
*/
public static TaggingOption newImplicitContextSpecific(int tagNo) {
@@ -56,7 +56,7 @@ public final class TaggingOption {
/**
* Create an explicit context specific tagging option with tagNo.
- * @param tagNo
+ * @param tagNo The tag number
* @return tagging option
*/
public static TaggingOption newExplicitContextSpecific(int tagNo) {
@@ -65,9 +65,9 @@ public final class TaggingOption {
/**
* The private constructor.
- * @param tagNo
- * @param isImplicit
- * @param isAppSpecific
+ * @param tagNo The tag number
+ * @param isImplicit Implicit or not
+ * @param isAppSpecific App specific or not
*/
private TaggingOption(int tagNo, boolean isImplicit, boolean isAppSpecific) {
this.tagNo = tagNo;
@@ -77,7 +77,7 @@ public final class TaggingOption {
/**
* Make tag flags giving it's tagged constructed.
- * @param isTaggedConstructed
+ * @param isTaggedConstructed Tagged Constructed or not
* @return tag flag
*/
public int tagFlags(boolean isTaggedConstructed) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
index 4f41998..f0fbf35 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/AbstractAsn1Type.java
@@ -44,8 +44,8 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
/**
* Default constructor, generally for decoding as a value container
- * @param tagClass
- * @param tagNo
+ * @param tagClass The tag class
+ * @param tagNo The tag number
*/
public AbstractAsn1Type(TagClass tagClass, int tagNo) {
this(tagClass, tagNo, null);
@@ -53,8 +53,8 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
/**
* Default constructor, generally for decoding as a value container
- * @param tagFlags
- * @param tagNo
+ * @param tagFlags The tag flags
+ * @param tagNo The tag number
*/
public AbstractAsn1Type(int tagFlags, int tagNo) {
this(tagFlags, tagNo, null);
@@ -62,9 +62,9 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
/**
* Constructor with a value, generally for encoding of the value
- * @param tagFlags
- * @param tagNo
- * @param value
+ * @param tagFlags The tag flags
+ * @param tagNo The tag number
+ * @param value The value
*/
public AbstractAsn1Type(int tagFlags, int tagNo, T value) {
this(TagClass.fromTagFlags(tagFlags), tagNo, value);
@@ -73,8 +73,9 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
/**
* Constructor with a value, generally for encoding of the value
- * @param tagNo
- * @param value
+ * @param tagClass The tag class
+ * @param tagNo The tag number
+ * @param value The value
*/
public AbstractAsn1Type(TagClass tagClass, int tagNo, T value) {
this.tagClass = tagClass;
@@ -84,7 +85,7 @@ public abstract class AbstractAsn1Type<T> implements Asn1Type {
/**
* Set encoding option
- * @param encodingOption
+ * @param encodingOption The encoding option
*/
public void setEncodingOption(EncodingOption encodingOption) {
this.encodingOption = encodingOption;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
index 3fc70c2..3b70e52 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Boolean.java
@@ -43,7 +43,7 @@ public class Asn1Boolean extends Asn1Simple<Boolean> {
/**
* Constructor with a value, generally for encoding of the value
- * @param value
+ * @param value The boolean value
*/
public Asn1Boolean(Boolean value) {
super(UniversalTag.BOOLEAN, value);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
index 712356e..0c2e1f9 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1GeneralizedTime.java
@@ -36,6 +36,7 @@ public class Asn1GeneralizedTime extends Asn1Simple<Date> {
/**
* time in milliseconds
+ * @param time The long time
*/
public Asn1GeneralizedTime(long time) {
super(UniversalTag.GENERALIZED_TIME, new Date(time));
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
index 8a7a2af..877c2f3 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Simple.java
@@ -28,14 +28,13 @@ import java.nio.ByteBuffer;
/**
* ASN1 simple type, of single value other than complex type of multiple values.
- * @param <T>
*/
public abstract class Asn1Simple<T> extends AbstractAsn1Type<T> {
private byte[] bytes;
/**
* Default constructor, generally for decoding as a value container
- * @param tagNo
+ * @param tagNo The tag number
*/
public Asn1Simple(UniversalTag tagNo) {
this(tagNo, null);
@@ -43,8 +42,8 @@ public abstract class Asn1Simple<T> extends AbstractAsn1Type<T> {
/**
* Constructor with a value, generally for encoding of the value
- * @param tagNo
- * @param value
+ * @param tagNo The tag number
+ * @param value The value
*/
public Asn1Simple(UniversalTag tagNo, T value) {
super(TagClass.UNIVERSAL, tagNo.getValue(), value);
@@ -142,8 +141,8 @@ public abstract class Asn1Simple<T> extends AbstractAsn1Type<T> {
/**
* Create a simple ASN1 object given tagNo, using the default constructor with no value provided
- * @param tagNo
- * @return
+ * @param tagNo The tag number
+ * @return A simple ASN1 object
*/
public static Asn1Type createSimple(int tagNo) {
if (!isSimple(tagNo)) {
@@ -154,8 +153,8 @@ public abstract class Asn1Simple<T> extends AbstractAsn1Type<T> {
/**
* Create a simple ASN1 object given tagNo, using the default constructor with no value provided
- * @param tagNo
- * @return
+ * @param tagNo The tag number
+ * @return The simple ASN1 object
*/
public static Asn1Type createSimple(UniversalTag tagNo) {
if (!isSimple(tagNo)) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Type.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Type.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Type.java
index 3ddd16f..c77418b 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Type.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/type/Asn1Type.java
@@ -31,7 +31,7 @@ import java.nio.ByteBuffer;
public interface Asn1Type {
/**
*
- * @return
+ * @return The tag flags
*/
int tagFlags();
@@ -44,7 +44,7 @@ public interface Asn1Type {
/**
* Set encoding option.
* See {@link org.apache.kerby.asn1.EncodingOption}.
- * @param encodingOption
+ * @param encodingOption The encoding option
*/
void setEncodingOption(EncodingOption encodingOption);
@@ -63,35 +63,35 @@ public interface Asn1Type {
/**
* Encode the type, by recursively, using the provided buffer.
- * @param buffer
+ * @param buffer The byte buffer
*/
void encode(ByteBuffer buffer);
/**
* Decode the content bytes into this type.
- * @param content
- * @throws IOException
+ * @param content The content bytes
+ * @throws IOException e
*/
void decode(byte[] content) throws IOException;
/**
* Decode the content bytes into this type.
- * @param content
- * @throws IOException
+ * @param content The content bytes
+ * @throws IOException e
*/
void decode(ByteBuffer content) throws IOException;
/**
* Tag and encode this type using the provided tagging option.
- * @param taggingOption
+ * @param taggingOption The tagging option
* @return encoded bytes
*/
byte[] taggedEncode(TaggingOption taggingOption);
/**
* Tag and encode this type using the provided tagging option.
- * @param taggingOption
- * @return encoded bytes
+ * @param buffer The byte buffer
+ * @param taggingOption The tagging option
*/
void taggedEncode(ByteBuffer buffer, TaggingOption taggingOption);
@@ -101,9 +101,9 @@ public interface Asn1Type {
*
* See {@link org.apache.kerby.asn1.TaggingOption}
*
- * @param content
- * @param taggingOption
- * @throws IOException
+ * @param content The content bytes
+ * @param taggingOption The tagging option
+ * @throws IOException e
*/
void taggedDecode(ByteBuffer content, TaggingOption taggingOption) throws IOException;
@@ -113,9 +113,9 @@ public interface Asn1Type {
*
* See {@link org.apache.kerby.asn1.TaggingOption}
*
- * @param content
- * @param taggingOption
- * @throws IOException
+ * @param content The content bytes
+ * @param taggingOption The tagging option
+ * @throws IOException e
*/
void taggedDecode(byte[] content, TaggingOption taggingOption) throws IOException;
}
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-config/src/main/java/org/apache/kerby/config/Config.java
----------------------------------------------------------------------
diff --git a/kerby-config/src/main/java/org/apache/kerby/config/Config.java b/kerby-config/src/main/java/org/apache/kerby/config/Config.java
index 2eade15..81fe9f3 100644
--- a/kerby-config/src/main/java/org/apache/kerby/config/Config.java
+++ b/kerby-config/src/main/java/org/apache/kerby/config/Config.java
@@ -37,15 +37,15 @@ public interface Config {
/**
* Set a string value for the specified property
- * @param name
- * @param value
+ * @param name The property name
+ * @param value The string value
*/
void setString(String name, String value);
/**
* Set a string value for the specified property
- * @param name
- * @param value
+ * @param name The config key name
+ * @param value The string value
*/
void setString(ConfigKey name, String value);
@@ -57,15 +57,15 @@ public interface Config {
/**
* Set a boolean value for the specified property
- * @param name
- * @param value
+ * @param name The property name
+ * @param value The boolean value
*/
void setBoolean(String name, boolean value);
/**
* Set a boolean value for the specified property
- * @param name
- * @param value
+ * @param name The config key name
+ * @param value The boolean value
*/
void setBoolean(ConfigKey name, boolean value);
@@ -75,15 +75,15 @@ public interface Config {
/**
* Set an int value for the specified property
- * @param name
- * @param value
+ * @param name The property name
+ * @param value The string value
*/
void setInt(String name, int value);
/**
* Set an int value for the specified property
- * @param name
- * @param value
+ * @param name The config key name
+ * @param value The int value
*/
void setInt(ConfigKey name, int value);
@@ -94,15 +94,15 @@ public interface Config {
/**
* Set a long value for the specified property
- * @param name
- * @param value
+ * @param name The property name
+ * @param value The long value
*/
void setLong(String name, long value);
/**
* Set a long value for the specified property
- * @param name
- * @param value
+ * @param name The config key name
+ * @param value The long value
*/
void setLong(ConfigKey name, long value);
@@ -112,15 +112,15 @@ public interface Config {
/**
* Set a float value for the specified property
- * @param name
- * @param value
+ * @param name The property name
+ * @param value The float value
*/
void setFloat(String name, float value);
/**
* Set a float value for the specified property
- * @param name
- * @param value
+ * @param name The config key name
+ * @param value The float value
*/
void setFloat(ConfigKey name, float value);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-util/src/main/java/org/apache/kerby/KOptions.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/KOptions.java b/kerby-util/src/main/java/org/apache/kerby/KOptions.java
index 0094610..4ea1103 100644
--- a/kerby-util/src/main/java/org/apache/kerby/KOptions.java
+++ b/kerby-util/src/main/java/org/apache/kerby/KOptions.java
@@ -39,8 +39,8 @@ public class KOptions {
/**
* Parse string value according to kopt type.
- * @param kopt
- * @param strValue
+ * @param kopt The koption
+ * @param strValue The string value
* @return true when successful, false otherwise
*/
public static boolean parseSetValue(KOption kopt, String strValue) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-util/src/main/java/org/apache/kerby/util/Base64.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Base64.java b/kerby-util/src/main/java/org/apache/kerby/util/Base64.java
index 143c8cc..fa112ba 100644
--- a/kerby-util/src/main/java/org/apache/kerby/util/Base64.java
+++ b/kerby-util/src/main/java/org/apache/kerby/util/Base64.java
@@ -28,13 +28,13 @@ import java.math.BigInteger;
* </p>
* <p>
* The class can be parameterized in the following manner with various constructors:
+ * </p>
* <ul>
* <li>URL-safe mode: Default off.</li>
* <li>Line length: Default 76. Line length that aren't multiples of 4 will still essentially end up being multiples of
- * 4 in the encoded data.
+ * 4 in the encoded data.</li>
* <li>Line separator: Default is CRLF ("\r\n")</li>
* </ul>
- * </p>
* <p>
* Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
* character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
@@ -254,7 +254,7 @@ public class Base64 {
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
- * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+ * If {@code lineLength <= 0}, then the output will not be divided into lines (chunks). Ignored when decoding.
* @since 1.4
*/
public Base64(int lineLength) {
@@ -276,7 +276,7 @@ public class Base64 {
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
- * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+ * If {@code lineLength <= 0}, then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
* @throws IllegalArgumentException
@@ -302,7 +302,7 @@ public class Base64 {
*
* @param lineLength
* Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
- * If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+ * If {@code lineLength <= 0}, then the output will not be divided into lines (chunks). Ignored when decoding.
* @param lineSeparator
* Each line of encoded data will end with this sequence of bytes.
* @param urlSafe
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java b/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java
index 52bab54..2d23b2d 100644
--- a/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java
+++ b/kerby-util/src/main/java/org/apache/kerby/util/Base64InputStream.java
@@ -86,11 +86,11 @@ public class Base64InputStream extends FilterInputStream {
* true if we should encode all data read from us, false if we should decode.
* @param lineLength
* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
- * nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
+ * nearest multiple of 4). If {@code lineLength <=0}, the encoded data is not divided into lines. If doEncode is
* false, lineLength is ignored.
* @param lineSeparator
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
- * If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
+ * If {@code lineLength <= 0}, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
*/
public Base64InputStream(InputStream in, boolean doEncode, int lineLength, byte[] lineSeparator) {
super(in);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java b/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java
index b2e09ba..6bb9f5d 100644
--- a/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java
+++ b/kerby-util/src/main/java/org/apache/kerby/util/Base64OutputStream.java
@@ -85,11 +85,11 @@ public class Base64OutputStream extends FilterOutputStream {
* true if we should encode all data written to us, false if we should decode.
* @param lineLength
* If doEncode is true, each line of encoded data will contain lineLength characters (rounded down to
- * nearest multiple of 4). If lineLength <=0, the encoded data is not divided into lines. If doEncode is
+ * nearest multiple of 4). If {@code lineLength <=0}, the encoded data is not divided into lines. If doEncode is
* false, lineLength is ignored.
* @param lineSeparator
* If doEncode is true, each line of encoded data will be terminated with this byte sequence (e.g. \r\n).
- * If lineLength <= 0, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
+ * If {@code lineLength <= 0}, the lineSeparator is not used. If doEncode is false lineSeparator is ignored.
*/
public Base64OutputStream(OutputStream out, boolean doEncode, int lineLength, byte[] lineSeparator) {
super(out);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java
index 39442ee..93f6dfd 100644
--- a/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java
+++ b/kerby-util/src/main/java/org/apache/kerby/util/HexUtil.java
@@ -28,6 +28,8 @@ public final class HexUtil {
/**
* Convert bytes into format as:
* 02020080
+ * @param bytes The bytes
+ * @return The hex string
*/
public static String bytesToHex(byte[] bytes) {
int len = bytes.length * 2;
@@ -44,6 +46,8 @@ public final class HexUtil {
/**
* Convert hex string like follows into byte array
* 02020080
+ * @param hexString The hex string
+ * @return The bytes
*/
public static byte[] hex2bytes(String hexString) {
hexString = hexString.toUpperCase();
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4a60163e/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
index f3760b5..bb07a8e 100644
--- a/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
+++ b/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
@@ -60,8 +60,8 @@ public final class IOUtil {
/**
* Read an input stream and return the content as string assuming UTF8.
- * @param in
- * @return
+ * @param in The input stream
+ * @return The content
* @throws IOException
*/
public static String readInput(InputStream in) throws IOException {
@@ -71,8 +71,8 @@ public final class IOUtil {
/**
* Read a file and return the content as string assuming UTF8.
- * @param file
- * @return
+ * @param file The file to read
+ * @return The content
* @throws IOException
*/
public static String readFile(File file) throws IOException {
@@ -92,8 +92,8 @@ public final class IOUtil {
/**
* Write a file with the content assuming UTF8.
- * @param content
- * @param file
+ * @param content The content
+ * @param file The file to write
* @throws IOException
*/
public static void writeFile(String content, File file) throws IOException {