JDK 9 RFR of JDK-8075034: Bad javadoc tags in javax.xml.crypto.dsig

[Sean Mullan]

Looks good.

Thanks,
Sean

On 03/11/2015 10:31 PM, joe darcy wrote:
> Hello,
>
> Please review the patch below to correct JDK-8075034: Bad javadoc tags
> in javax.xml.crypto.dsig.
>
> In several cases, the javadoc uses unescaped "<" and ">" characters
> which is flagged as a problem by doclint. In addition, the javadoc as it
> currently stands renders improperly and omits the generics information;
> in other words, the code in the javadoc gets listed as
>
>      List references ....
>
> rather than
>
>      List<Reference> references ...
>
> as intended. I have verified a docs build with the fix produced the
> desired output.
>
> I came across this javadoc issue while working on a fix for JDK-8072734:
> Turn on doclint checking in the build of modules in the jdk repo. Fixing
> JDK-8075034 will allow full doclint checking on the module containing
> javax.xml.crypto.dsig.
>
> Thanks,
>
> -Joe
>
> diff -r bd800bc5d699
> src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/Manifest.java
> ---
> a/src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/Manifest.java
> Wed Mar 11 08:33:12 2015 -0700
> +++
> b/src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/Manifest.java
> Wed Mar 11 19:25:51 2015 -0700
> @@ -52,7 +52,7 @@
>    * <pre>
>    *   XMLSignatureFactory factory =
> XMLSignatureFactory.getInstance("DOM");
>    *   Reference ref = factory.newReference("#reference-1",
> DigestMethod.SHA1);
> - *   List<Reference> references = Collections.singletonList(ref);
> + *   List<Reference> references = Collections.singletonList(ref);
>    *   Manifest manifest = factory.newManifest(references, "manifest-1");
>    * </pre>
>    *
> diff -r bd800bc5d699
> src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/XMLObject.java
> ---
> a/src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/XMLObject.java
> Wed Mar 11 08:33:12 2015 -0700
> +++
> b/src/java.xml.crypto/share/classes/javax/xml/crypto/dsig/XMLObject.java
> Wed Mar 11 19:25:51 2015 -0700
> @@ -65,7 +65,7 @@
>    * <pre>
>    *   XMLSignatureFactory fac = XMLSignatureFactory.getInstance("DOM");
>    *   Manifest manifest = fac.newManifest(references);
> - *   List<XMLStructure> content = Collections.singletonList(manifest);
> + *   List<XMLStructure> content =
> Collections.singletonList(manifest);
>    *   XMLObject object = factory.newXMLObject(content, "object-1",
> null, null);
>    * </pre>
>    *
>