[security-dev 00036]: Re: Code review request: 6634644 broken fragment, should use @link

[Sean Mullan]

Hi Max,

The fix looks fine.

--Sean

Max (Weijun) Wang wrote:
> Hi Sean
> 
> There's a bug on spec inside javax.security.cert.X509Certificate
> 
> -----START BUG REPORT-----
> 6634644 broken fragment, should use @link
> 
> Broken fragment in api doc, following lines in 
> javax/security/cert/X509Certificate.java should be fixed.
> line 366:     * <p>See <a href = "#getIssuerDN">getIssuerDN</a> for 
> <code>Name</code>
>         broken fragment #getIssuerDN
>         should use {@link #getIssuerDN getIssuerDN}
> similar for following:
> line 396:     * the certificate. See <a href = 
> "#getNotBefore">getNotBefore</a>
> line 432:     * <p>See <a href = "#getSigAlgName">getSigAlgName</a> for
> line 445:     * <p>See <a href = "#getSigAlgName">getSigAlgName</a> for
> -----END BUG REPORT-----
> 
> The package is now obsolete. However, since the API is still externally 
> exported, I suggest fixing it. Here's the patch:
> 
> --- a/src/share/classes/javax/security/cert/X509Certificate.java    Wed 
> Dec 19 13:42:51 2007 +0800
> +++ b/src/share/classes/javax/security/cert/X509Certificate.java    Mon 
> Dec 24 18:59:54 2007 +0800
> @@ -363,7 +363,7 @@ public abstract class X509Certificate ex
>       * subject    Name
>       * </pre>
>       *
> -     * <p>See <a href = "#getIssuerDN">getIssuerDN</a> for 
> <code>Name</code>
> +     * <p>See {@link #getIssuerDN() getIssuerDN} for <code>Name</code>
>       * and other relevant definitions.
>       *
>       * @return a Principal whose name is the subject name.
> @@ -393,7 +393,7 @@ public abstract class X509Certificate ex
> 
>      /**
>       * Gets the <code>notAfter</code> date from the validity period of
> -     * the certificate. See <a href = "#getNotBefore">getNotBefore</a>
> +     * the certificate. See {@link #getNotBefore() getNotBefore}
>       * for relevant ASN.1 definitions.
>       *
>       * @return the end date of the validity period.
> @@ -429,7 +429,7 @@ public abstract class X509Certificate ex
>       * For example, the string "1.2.840.10040.4.3" identifies the SHA-1
>       * with DSA signature algorithm, as per the PKIX part I.
>       *
> -     * <p>See <a href = "#getSigAlgName">getSigAlgName</a> for
> +     * <p>See {@link #getSigAlgName() getSigAlgName} for
>       * relevant ASN.1 definitions.
>       *
>       * @return the signature algorithm OID string.
> @@ -442,7 +442,7 @@ public abstract class X509Certificate ex
>       * algorithm parameters are null; the parameters are usually
>       * supplied with the certificate's public key.
>       *
> -     * <p>See <a href = "#getSigAlgName">getSigAlgName</a> for
> +     * <p>See {@link #getSigAlgName() getSigAlgName} for
>       * relevant ASN.1 definitions.
>       *
>       * @return the DER-encoded signature algorithm parameters, or
> 
> Can you take a code review please?
> 
> Thanks
> Max
> 
> ps. I find it ultra inconvenient to ask for a code review while the bug 
> db and code repo is still not in the open, but will give it a try for 
> this tiny bug.