Skip to content

Commit

Permalink
Fix JavaDoc markup
Browse files Browse the repository at this point in the history
  • Loading branch information
ndw committed Sep 19, 2022
1 parent 970a982 commit 91df7bd
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/drivers/CalabashTask.java
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ public void addConfiguredPipeline(UseableResources pipeline) {
/**
* Set the destination directory into which the XSL result
* files should be copied to;
* required, unless <tt>in</tt> and <tt>out</tt> are
* required, unless <code>in</code> and <code>out</code> are
* specified.
*
* @param dir the name of the destination directory
Expand Down
32 changes: 16 additions & 16 deletions src/main/java/com/xmlcalabash/util/Base64.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* <p>Encodes and decodes to and from Base64 notation.</p>
* <p>Homepage: <a href="http://iharder.net/base64">http://iharder.net/base64</a>.</p>
*
* <p>The <tt>options</tt> parameter, which appears in a few places, is used to pass
* <p>The <code>options</code> 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
Expand Down Expand Up @@ -61,9 +61,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 (<tt>int</tt>s that you "OR" together).</li>
* options format (<code>int</code>s that you "OR" together).</li>
* <li>v1.5.1 - Fixed bug when decompressing and decoding to a
* byte[] using <tt>decode( String s, boolean gzipCompressed )</tt>.
* byte[] using <code>decode( String s, boolean gzipCompressed )</code>.
* 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).</li>
Expand Down Expand Up @@ -507,7 +507,7 @@ private static void closeOrLog(java.io.Closeable c) {
* Serializes an object and returns the Base64-encoded
* version of that serialized object. If the object
* cannot be serialized or there is another error,
* the method will return <tt>null</tt>.
* the method will return <code>null</code>.
* The object is not GZip-compressed before being encoded.
*
* @param serializableObject The object to encode
Expand All @@ -525,7 +525,7 @@ public static String encodeObject( java.io.Serializable serializableObject )
* Serializes an object and returns the Base64-encoded
* version of that serialized object. If the object
* cannot be serialized or there is another error,
* the method will return <tt>null</tt>.
* the method will return <code>null</code>.
* <p>
* Valid options:<pre>
* GZIP: gzip-compresses object before encoding it.
Expand Down Expand Up @@ -1045,7 +1045,7 @@ public static byte[] decode( String s, int options )

/**
* Attempts to decode Base64 data and deserialize a Java
* Object within. Returns <tt>null</tt> if there was an error.
* Object within. Returns <code>null</code> if there was an error.
*
* @param encodedObject The Base64 data to decode
* @return The decoded and deserialized object
Expand Down Expand Up @@ -1097,7 +1097,7 @@ public static Object decodeToObject( String encodedObject )
*
* @param dataToEncode byte array of data to encode in base64 form
* @param filename Filename for saving encoded data
* @return <tt>true</tt> if successful, <tt>false</tt> otherwise
* @return <code>true</code> if successful, <code>false</code> otherwise
*
* @since 2.1
*/
Expand Down Expand Up @@ -1134,7 +1134,7 @@ public static boolean encodeToFile( byte[] dataToEncode, String filename )
*
* @param dataToDecode Base64-encoded data as a string
* @param filename Filename for saving decoded data
* @return <tt>true</tt> if successful, <tt>false</tt> otherwise
* @return <code>true</code> if successful, <code>false</code> otherwise
*
* @since 2.1
*/
Expand Down Expand Up @@ -1280,7 +1280,7 @@ public static String encodeFromFile( String filename )


/**
* Reads <tt>infile</tt> and encodes it to <tt>outfile</tt>.
* Reads <code>infile</code> and encodes it to <code>outfile</code>.
*
* @param infile Input file
* @param outfile Output file
Expand Down Expand Up @@ -1321,7 +1321,7 @@ public static boolean encodeFileToFile( String infile, String outfile )


/**
* Reads <tt>infile</tt> and decodes it to <tt>outfile</tt>.
* Reads <code>infile</code> and decodes it to <code>outfile</code>.
*
* @param infile Input file
* @param outfile Output file
Expand Down Expand Up @@ -1366,7 +1366,7 @@ public static boolean decodeFileToFile( String infile, String outfile )

/**
* A {@link Base64.InputStream} will read data from another
* <tt>java.io.InputStream</tt>, given in the constructor,
* <code>java.io.InputStream</code>, given in the constructor,
* and encode/decode to/from Base64 notation on the fly.
*
* @see Base64
Expand All @@ -1389,7 +1389,7 @@ public static class InputStream extends java.io.FilterInputStream
/**
* Constructs a {@link Base64.InputStream} in DECODE mode.
*
* @param in the <tt>java.io.InputStream</tt> from which to read data.
* @param in the <code>java.io.InputStream</code> from which to read data.
* @since 1.3
*/
public InputStream( java.io.InputStream in )
Expand All @@ -1412,7 +1412,7 @@ public InputStream( java.io.InputStream in )
* Example: <code>new Base64.InputStream( in, Base64.DECODE )</code>
*
*
* @param in the <tt>java.io.InputStream</tt> from which to read data.
* @param in the <code>java.io.InputStream</code> from which to read data.
* @param options Specified options
* @see Base64#ENCODE
* @see Base64#DECODE
Expand Down Expand Up @@ -1602,7 +1602,7 @@ else if( i == 0 )

/**
* A {@link Base64.OutputStream} will write data to another
* <tt>java.io.OutputStream</tt>, given in the constructor,
* <code>java.io.OutputStream</code>, given in the constructor,
* and encode/decode to/from Base64 notation on the fly.
*
* @see Base64
Expand All @@ -1625,7 +1625,7 @@ public static class OutputStream extends java.io.FilterOutputStream
/**
* Constructs a {@link Base64.OutputStream} in ENCODE mode.
*
* @param out the <tt>java.io.OutputStream</tt> to which data will be written.
* @param out the <code>java.io.OutputStream</code> to which data will be written.
* @since 1.3
*/
public OutputStream( java.io.OutputStream out )
Expand All @@ -1647,7 +1647,7 @@ public OutputStream( java.io.OutputStream out )
* <p>
* Example: <code>new Base64.OutputStream( out, Base64.ENCODE )</code>
*
* @param out the <tt>java.io.OutputStream</tt> to which data will be written.
* @param out the <code>java.io.OutputStream</code> to which data will be written.
* @param options Specified options.
* @see Base64#ENCODE
* @see Base64#DECODE
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/xmlcalabash/util/RebasedDocument.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@


/**
* A <tt>RebasedDocument</tt> represents a view of a real Document in which all nodes are mapped to a different
* A <code>RebasedDocument</code> represents a view of a real Document in which all nodes are mapped to a different
* base URI and/or system ID using supplied mapping functions.
*
* <p>It is possible to map either base URIs or system IDs or both.</p>
Expand Down

0 comments on commit 91df7bd

Please sign in to comment.