More CMS Javadoc cleaning

13 files changed, 37 insertions, 24 deletions

diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/Attributes.java b/core/src/main/java/org/bouncycastle/asn1/cms/Attributes.java
index 99e54d60..ad34b7e4 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/Attributes.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/Attributes.java
@@ -44,7 +44,7 @@ public class Attributes
      * <ul>
      * <li> null &rarr; null
      * <li> {@link Attributes} object
-     * <li> {@link org.bouncycastle.asn1.ASN1Set ASN1Set} input formats with Attributes structure inside
+     * <li> {@link org.bouncycastle.asn1.ASN1Set#getInstance(java.lang.Object) ASN1Set} input formats with Attributes structure inside
      * </ul>
      *
      * @param o the object we want converted.
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/AuthEnvelopedData.java b/core/src/main/java/org/bouncycastle/asn1/cms/AuthEnvelopedData.java
index 27bdee84..1eaf68ca 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/AuthEnvelopedData.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/AuthEnvelopedData.java
@@ -129,7 +129,7 @@ public class AuthEnvelopedData
      * <p>
      * Accepted inputs:
      * <ul>
-     * <li> {@link ASN1Sequence org.bouncycastle.asn1.ASN1Sequence} input formats
+     * <li> {@link org.bouncycastle.asn1.ASN1Sequence#getInstance(java.lang.Object) ASN1Sequence} input formats
      * </ul>
      *
 
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/ContentInfo.java b/core/src/main/java/org/bouncycastle/asn1/cms/ContentInfo.java
index 4fcd3982..be0211c2 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/ContentInfo.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/ContentInfo.java
@@ -11,19 +11,19 @@ import org.bouncycastle.asn1.BERSequence;
 import org.bouncycastle.asn1.BERTaggedObject;
 
 /**
- * <a href="http://tools.ietf.org/html/rfc5652#section-3">RFC 5652</a> ContentInfo object.
+ * <a href="http://tools.ietf.org/html/rfc5652#section-3">RFC 5652</a> ContentInfo, and 
+ * <a href="http://tools.ietf.org/html/rfc5652#section-5.2">RFC 5652</a> EncapsulatedContentInfo objects.
  *
  * <pre>
  * ContentInfo ::= SEQUENCE {
  *     contentType ContentType,
- *     content [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL }
- * </pre>
+ *     content [0] EXPLICIT ANY DEFINED BY contentType OPTIONAL
+ * }
  *
- * <a href="http://tools.ietf.org/html/rfc5652#section-5.2">RFC 5652</a> EncapsulatedContentInfo object.
- * <pre>
  * EncapsulatedContentInfo ::= SEQUENCE {
  *     eContentType ContentType,
- *     eContent [0] EXPLICIT OCTET STRING OPTIONAL }
+ *     eContent [0] EXPLICIT OCTET STRING OPTIONAL
+ * }
  * </pre>
  */
 
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/Evidence.java b/core/src/main/java/org/bouncycastle/asn1/cms/Evidence.java
index 9bfdaa23..46ab19c6 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/Evidence.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/Evidence.java
@@ -44,7 +44,7 @@ public class Evidence
      * Accepted inputs:
      * <ul>
      * <li> {@link Evidence} object
-     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject ASN1TaggedObject} input formats with Evidence data inside
+     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject#getInstance(java.lang.Object) ASN1TaggedObject} input formats with Evidence data inside
      * </ul>
      *
      * @param o the object we want converted.
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/KeyAgreeRecipientIdentifier.java b/core/src/main/java/org/bouncycastle/asn1/cms/KeyAgreeRecipientIdentifier.java
index e281f12a..6580cd4d 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/KeyAgreeRecipientIdentifier.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/KeyAgreeRecipientIdentifier.java
@@ -47,7 +47,7 @@ public class KeyAgreeRecipientIdentifier
      * <ul>
      * <li> {@link KeyAgreeRecipientIdentifier} object
      * <li> {@link org.bouncycastle.asn1.ASN1Sequence#getInstance(java.lang.Object) ASN1Sequence} input formats with IssuerAndSerialNumber structure inside
-     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject ASN1TaggedObject} with tag value 0: a KeyAgreeRecipientIdentifier data structure
+     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject#getInstance(java.lang.Object) ASN1TaggedObject} with tag value 0: a KeyAgreeRecipientIdentifier data structure
      * </ul>
      * <p>
      * Note: no byte[] input!
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/OriginatorIdentifierOrKey.java b/core/src/main/java/org/bouncycastle/asn1/cms/OriginatorIdentifierOrKey.java
index aa27d873..2096be26 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/OriginatorIdentifierOrKey.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/OriginatorIdentifierOrKey.java
@@ -96,7 +96,7 @@ public class OriginatorIdentifierOrKey
      * <li> {@link IssuerAndSerialNumber} object
      * <li> {@link SubjectKeyIdentifier} object
      * <li> {@link OriginatorPublicKey} object
-     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject ASN1TaggedObject} input formats with IssuerAndSerialNumber structure inside
+     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject#getInstance(java.lang.Object) ASN1TaggedObject} input formats with IssuerAndSerialNumber structure inside
      * </ul>
      *
      * @param o the object we want converted.
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/OtherRecipientInfo.java b/core/src/main/java/org/bouncycastle/asn1/cms/OtherRecipientInfo.java
index 4f9b618a..8247391e 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/OtherRecipientInfo.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/OtherRecipientInfo.java
@@ -79,12 +79,12 @@ public class OtherRecipientInfo
         {
             return (OtherRecipientInfo)obj;
         }
-
+        
         if (obj != null)
         {
             return new OtherRecipientInfo(ASN1Sequence.getInstance(obj));
         }
-
+        
         return null;
     }
 
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/OtherRevocationInfoFormat.java b/core/src/main/java/org/bouncycastle/asn1/cms/OtherRevocationInfoFormat.java
index f635f896..06ae52db 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/OtherRevocationInfoFormat.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/OtherRevocationInfoFormat.java
@@ -76,12 +76,12 @@ public class OtherRevocationInfoFormat
         {
             return (OtherRevocationInfoFormat)obj;
         }
-
+        
         if (obj != null)
         {
             return new OtherRevocationInfoFormat(ASN1Sequence.getInstance(obj));
         }
-
+        
         return null;
     }
 
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/RecipientIdentifier.java b/core/src/main/java/org/bouncycastle/asn1/cms/RecipientIdentifier.java
index d23ceaa8..66b154a0 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/RecipientIdentifier.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/RecipientIdentifier.java
@@ -52,8 +52,8 @@ public class RecipientIdentifier
      * <li> null &rarr; null
      * <li> {@link RecipientIdentifier} object
      * <li> {@link IssuerAndSerialNumber} object
-     * <li> {@link org.bouncycastle.asn1.ASN1OctetString ASN1OctetString} input formats (OctetString, byte[]) with value of KeyIdentifier in DER form.
-     * <li> {@link org.bouncycastle.asn1.ASN1Primitive ASN1Primitive}
+     * <li> {@link org.bouncycastle.asn1.ASN1OctetString#getInstance(java.lang.Object) ASN1OctetString} input formats (OctetString, byte[]) with value of KeyIdentifier in DER form
+     * <li> {@link org.bouncycastle.asn1.ASN1Primitive ASN1Primitive} for RecipientIdentifier constructor
      * </ul>
      *
      * @param o the object we want converted.
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/RecipientInfo.java b/core/src/main/java/org/bouncycastle/asn1/cms/RecipientInfo.java
index 8fd2e546..f92d0cc7 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/RecipientInfo.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/RecipientInfo.java
@@ -72,7 +72,7 @@ public class RecipientInfo
      * <li> null &rarr; null
      * <li> {@link RecipientInfo} object
      * <li> {@link org.bouncycastle.asn1.ASN1Sequence#getInstance(java.lang.Object) ASN1Sequence} input formats with RecipientInfo structure inside
-     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject ASN1TaggedObject} input formats with RecipientInfo structure inside
+     * <li> {@link org.bouncycastle.asn1.ASN1TaggedObject#getInstance(java.lang.Object) ASN1TaggedObject} input formats with RecipientInfo structure inside
      * </ul>
      *
      * @param obj the object we want converted.
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/SignerIdentifier.java b/core/src/main/java/org/bouncycastle/asn1/cms/SignerIdentifier.java
index fddcb445..9139157d 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/SignerIdentifier.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/SignerIdentifier.java
@@ -56,8 +56,8 @@ public class SignerIdentifier
      * <li> null &rarr; null
      * <li> {@link SignerIdentifier} object
      * <li> {@link IssuerAndSerialNumber} object
-     * <li> {@link org.bouncycastle.asn1.ASN1OctetString ASN1OctetString} input formats with SignerIdentifier structure inside
-     * <li> {@link org.bouncycastle.asn1.ASN1Primitive ASN1Primitive} ??
+     * <li> {@link org.bouncycastle.asn1.ASN1OctetString#getInstance(java.lang.Object) ASN1OctetString} input formats with SignerIdentifier structure inside
+     * <li> {@link org.bouncycastle.asn1.ASN1Primitive ASN1Primitive} for SignerIdentifier constructor.
      * </ul>
      *
      * @param o the object we want converted.
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/Time.java b/core/src/main/java/org/bouncycastle/asn1/cms/Time.java
index 627569dd..19c4dca8 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/Time.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/Time.java
@@ -24,7 +24,7 @@ import org.bouncycastle.asn1.DERUTCTime;
  * <p>
  * This has a constructor using java.util.Date for input which generates
  * a {@link org.bouncycastle.asn1.DERUTCTime DERUTCTime} object if the
- * supplied datetime is in range 1950-01-01-00:00:00 UTC to 2049-12-31-23:59:60 UTC.
+ * supplied datetime is in range 1950-01-01-00:00:00 UTC until 2049-12-31-23:59:60 UTC.
  * If the datetime value is outside that range, the generated object will be
  * {@link org.bouncycastle.asn1.DERGeneralizedTime DERGeneralizedTime}.
  */
@@ -54,7 +54,7 @@ public class Time
     }
 
     /**
-     * Creates a time object from a given date - if the date is between 1950
+     * Create a time object from a given date - if the year is in between 1950
      * and 2049 a UTCTime object is generated, otherwise a GeneralizedTime
      * is used.
      */
@@ -112,6 +112,9 @@ public class Time
         throw new IllegalArgumentException("unknown object in factory: " + obj.getClass().getName());
     }
 
+    /**
+     * Get the date+tine as a String in full form century format.
+     */
     public String getTime()
     {
         if (time instanceof DERUTCTime)
@@ -124,6 +127,9 @@ public class Time
         }
     }
 
+    /**
+     * Get java.util.Date version of date+time.
+     */
     public Date getDate()
     {
         try
diff --git a/core/src/main/java/org/bouncycastle/asn1/cms/ecc/MQVuserKeyingMaterial.java b/core/src/main/java/org/bouncycastle/asn1/cms/ecc/MQVuserKeyingMaterial.java
index aa5a4421..bd7267ba 100644
--- a/core/src/main/java/org/bouncycastle/asn1/cms/ecc/MQVuserKeyingMaterial.java
+++ b/core/src/main/java/org/bouncycastle/asn1/cms/ecc/MQVuserKeyingMaterial.java
@@ -50,7 +50,7 @@ public class MQVuserKeyingMaterial
     }
 
     /**
-     * return an MQVuserKeyingMaterial object from a tagged object.
+     * Return an MQVuserKeyingMaterial object from a tagged object.
      *
      * @param obj      the tagged object holding the object we want.
      * @param explicit true if the object is meant to be explicitly
@@ -66,7 +66,14 @@ public class MQVuserKeyingMaterial
     }
 
     /**
-     * return an MQVuserKeyingMaterial object from the given object.
+     * Return an MQVuserKeyingMaterial object from the given object.
+     * <p>
+     * Accepted inputs:
+     * <ul>
+     * <li> null &rarr; null
+     * <li> {@link MQVuserKeyingMaterial} object
+     * <li> {@link org.bouncycastle.asn1.ASN1Sequence ASN1Sequence} with MQVuserKeyingMaterial inside it.
+     * </ul>
      *
      * @param obj the object we want converted.
      * @throws IllegalArgumentException if the object cannot be converted.