JavaDoc

9 files changed, 21 insertions, 3 deletions

diff --git a/core/src/main/java/org/bouncycastle/util/encoders/Base64.java b/core/src/main/java/org/bouncycastle/util/encoders/Base64.java
index 83806295..c04a8cc1 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/Base64.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/Base64.java
@@ -6,6 +6,9 @@ import java.io.OutputStream;
 
 import org.bouncycastle.util.Strings;
 
+/**
+ * Utility class for converting Base64 data to bytes and back again.
+ */
 public class Base64
 {
     private static final Encoder encoder = new Base64Encoder();
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/Base64Encoder.java b/core/src/main/java/org/bouncycastle/util/encoders/Base64Encoder.java
index ddcfc34f..abad02c5 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/Base64Encoder.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/Base64Encoder.java
@@ -3,6 +3,9 @@ package org.bouncycastle.util.encoders;
 import java.io.IOException;
 import java.io.OutputStream;
 
+/**
+ * A streaming Base64 encoder.
+ */
 public class Base64Encoder
     implements Encoder
 {
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/BufferedDecoder.java b/core/src/main/java/org/bouncycastle/util/encoders/BufferedDecoder.java
index 672430ac..eea85b9f 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/BufferedDecoder.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/BufferedDecoder.java
@@ -2,7 +2,7 @@ package org.bouncycastle.util.encoders;
 
 
 /**
- * a buffering class to allow translation from one format to another to
+ * A buffering class to allow translation from one format to another to
  * be done in discrete chunks.
  */
 public class BufferedDecoder
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/BufferedEncoder.java b/core/src/main/java/org/bouncycastle/util/encoders/BufferedEncoder.java
index 107eee89..60a098de 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/BufferedEncoder.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/BufferedEncoder.java
@@ -2,7 +2,7 @@ package org.bouncycastle.util.encoders;
 
 
 /**
- * a buffering class to allow translation from one format to another to
+ * A buffering class to allow translation from one format to another to
  * be done in discrete chunks.
  */
 public class BufferedEncoder
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/DecoderException.java b/core/src/main/java/org/bouncycastle/util/encoders/DecoderException.java
index d9914a22..1e6782a5 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/DecoderException.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/DecoderException.java
@@ -1,5 +1,8 @@
 package org.bouncycastle.util.encoders;
 
+/**
+ * Exception thrown if an attempt is made to decode invalid data, or some other failure occurs.
+ */
 public class DecoderException
     extends IllegalStateException
 {
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/EncoderException.java b/core/src/main/java/org/bouncycastle/util/encoders/EncoderException.java
index 2d09a63a..a1eb411e 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/EncoderException.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/EncoderException.java
@@ -1,5 +1,8 @@
 package org.bouncycastle.util.encoders;
 
+/**
+ * Exception thrown if an attempt is made to encode invalid data, or some other failure occurs.
+ */
 public class EncoderException
     extends IllegalStateException
 {
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/Hex.java b/core/src/main/java/org/bouncycastle/util/encoders/Hex.java
index d49f1ef4..63e9c713 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/Hex.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/Hex.java
@@ -6,6 +6,9 @@ import java.io.OutputStream;
 
 import org.bouncycastle.util.Strings;
 
+/**
+ * Utility class for converting hex data to bytes and back again.
+ */
 public class Hex
 {
     private static final Encoder encoder = new HexEncoder();
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/HexEncoder.java b/core/src/main/java/org/bouncycastle/util/encoders/HexEncoder.java
index 3069c77d..52f8fa6d 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/HexEncoder.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/HexEncoder.java
@@ -3,6 +3,9 @@ package org.bouncycastle.util.encoders;
 import java.io.IOException;
 import java.io.OutputStream;
 
+/**
+ * A streaming Hex encoder.
+ */
 public class HexEncoder
     implements Encoder
 {
diff --git a/core/src/main/java/org/bouncycastle/util/encoders/Translator.java b/core/src/main/java/org/bouncycastle/util/encoders/Translator.java
index a3a0cb8e..96381bcf 100644
--- a/core/src/main/java/org/bouncycastle/util/encoders/Translator.java
+++ b/core/src/main/java/org/bouncycastle/util/encoders/Translator.java
@@ -1,7 +1,7 @@
 package org.bouncycastle.util.encoders;
 
 /**
- * general interface for an translator.
+ * General interface for an translator.
  */
 public interface Translator
 {