From 9c48a4d8a2884f0506fdce4f56f852a82e2008f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lu=C3=ADs=20Gon=C3=A7alves?= Date: Sat, 19 Feb 2022 19:19:17 +0000 Subject: [PATCH] Tweaks to javadocs --- pom.xml | 2 +- .../java/xades4j/algorithms/Algorithm.java | 2 +- .../production/BasicSignatureOptions.java | 2 +- src/main/java/xades4j/utils/Base64.java | 30 +++++++++---------- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/pom.xml b/pom.xml index a3032102..5e6a0b4c 100644 --- a/pom.xml +++ b/pom.xml @@ -132,7 +132,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.9.1 + 2.10.4 com.google.doclava diff --git a/src/main/java/xades4j/algorithms/Algorithm.java b/src/main/java/xades4j/algorithms/Algorithm.java index d03b18a5..f4ff6ce6 100644 --- a/src/main/java/xades4j/algorithms/Algorithm.java +++ b/src/main/java/xades4j/algorithms/Algorithm.java @@ -22,7 +22,7 @@ * signature algorithms or canonicalization algorithms. Subclasses are provided * for some common algorithms. * - * @see xades4j.providers.AlgorithmsProviderEx + * @see xades4j.production.SignatureAlgorithms * @see xades4j.properties.DataObjectDesc#withTransform(Algorithm) * * @author Luís diff --git a/src/main/java/xades4j/production/BasicSignatureOptions.java b/src/main/java/xades4j/production/BasicSignatureOptions.java index add4671e..3084d94a 100644 --- a/src/main/java/xades4j/production/BasicSignatureOptions.java +++ b/src/main/java/xades4j/production/BasicSignatureOptions.java @@ -20,7 +20,7 @@ * Configuration of basic signature options such as whether {@code ds:KeyInfo} * elements should be included. * - * @see XadesSigningProfile#withBasicSignatureOptions(BasicSignatureOptions). + * @see XadesSigningProfile#withBasicSignatureOptions(BasicSignatureOptions) * * @author luis */ diff --git a/src/main/java/xades4j/utils/Base64.java b/src/main/java/xades4j/utils/Base64.java index 83fd4d64..2b3b4ac2 100644 --- a/src/main/java/xades4j/utils/Base64.java +++ b/src/main/java/xades4j/utils/Base64.java @@ -9,7 +9,7 @@ *
* byte[] myByteArray = Base64.decode( encoded ); * - *

The options parameter, which appears in a few places, is used to pass + *

The options parameter, which appears in a few places, is used to pass * several pieces of information to the encoder. In the "higher level" methods such as * encodeBytes( bytes, options ) the options parameter can be used to indicate such * things as first gzipping the bytes before encoding them, not inserting linefeeds, @@ -117,9 +117,9 @@ * when data that's being decoded is gzip-compressed and will decompress it * automatically. Generally things are cleaner. You'll probably have to * change some method calls that you were making to support the new - * options format (ints that you "OR" together). + * options format (ints that you "OR" together). *

  • v1.5.1 - Fixed bug when decompressing and decoding to a - * byte[] using decode( String s, boolean gzipCompressed ). + * byte[] using decode( String s, boolean gzipCompressed ). * Added the ability to "suspend" encoding in the Output Stream so * you can turn on and off the encoding if you need to embed base64 * data in an otherwise "normal" stream (like an XML file).
    • @@ -1233,7 +1233,7 @@ public static byte[] decode( String s ) throws java.io.IOException { * @param options encode options such as URL_SAFE * @return the decoded data * @throws java.io.IOException if there is an error - * @throws NullPointerException if s is null + * @throws NullPointerException if s is null * @since 1.4 */ public static byte[] decode( String s, int options ) throws java.io.IOException { @@ -1300,7 +1300,7 @@ public static byte[] decode( String s, int options ) throws java.io.IOException /** * Attempts to decode Base64 data and deserialize a Java - * Object within. Returns null if there was an error. + * Object within. Returns null if there was an error. * * @param encodedObject The Base64 data to decode * @return The decoded and deserialized object @@ -1318,8 +1318,8 @@ public static Object decodeToObject( String encodedObject ) /** * Attempts to decode Base64 data and deserialize a Java - * Object within. Returns null if there was an error. - * If loader is not null, it will be the class loader + * Object within. Returns null if there was an error. + * If loader is not null, it will be the class loader * used when deserializing. * * @param encodedObject The Base64 data to decode @@ -1570,7 +1570,7 @@ public static String encodeFromFile( String filename ) } // end encodeFromFile /** - * Reads infile and encodes it to outfile. + * Reads infile and encodes it to outfile. * * @param infile Input file * @param outfile Output file @@ -1598,7 +1598,7 @@ public static void encodeFileToFile( String infile, String outfile ) /** - * Reads infile and decodes it to outfile. + * Reads infile and decodes it to outfile. * * @param infile Input file * @param outfile Output file @@ -1631,7 +1631,7 @@ public static void decodeFileToFile( String infile, String outfile ) /** * A {@link Base64.InputStream} will read data from another - * java.io.InputStream, given in the constructor, + * java.io.InputStream, given in the constructor, * and encode/decode to/from Base64 notation on the fly. * * @see Base64 @@ -1653,7 +1653,7 @@ public static class InputStream extends java.io.FilterInputStream { /** * Constructs a {@link Base64.InputStream} in DECODE mode. * - * @param in the java.io.InputStream from which to read data. + * @param in the java.io.InputStream from which to read data. * @since 1.3 */ public InputStream( java.io.InputStream in ) { @@ -1674,7 +1674,7 @@ public InputStream( java.io.InputStream in ) { * Example: new Base64.InputStream( in, Base64.DECODE ) * * - * @param in the java.io.InputStream from which to read data. + * @param in the java.io.InputStream from which to read data. * @param options Specified options * @see Base64#ENCODE * @see Base64#DECODE @@ -1844,7 +1844,7 @@ else if( i == 0 ) { /** * A {@link Base64.OutputStream} will write data to another - * java.io.OutputStream, given in the constructor, + * java.io.OutputStream, given in the constructor, * and encode/decode to/from Base64 notation on the fly. * * @see Base64 @@ -1866,7 +1866,7 @@ public static class OutputStream extends java.io.FilterOutputStream { /** * Constructs a {@link Base64.OutputStream} in ENCODE mode. * - * @param out the java.io.OutputStream to which data will be written. + * @param out the java.io.OutputStream to which data will be written. * @since 1.3 */ public OutputStream( java.io.OutputStream out ) { @@ -1886,7 +1886,7 @@ public OutputStream( java.io.OutputStream out ) { *

    * Example: new Base64.OutputStream( out, Base64.ENCODE ) * - * @param out the java.io.OutputStream to which data will be written. + * @param out the java.io.OutputStream to which data will be written. * @param options Specified options. * @see Base64#ENCODE * @see Base64#DECODE