From: AsamK Date: Tue, 7 Jul 2015 10:31:20 +0000 (+0200) Subject: Reformat javadoc X-Git-Tag: v0.0.2~5 X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/6af605f79091fb55f6af46677d11011dc63e244d Reformat javadoc --- diff --git a/src/main/java/cli/Base64.java b/src/main/java/cli/Base64.java index 061932ab..b2a28591 100644 --- a/src/main/java/cli/Base64.java +++ b/src/main/java/cli/Base64.java @@ -3,34 +3,34 @@ package cli; /** *

Encodes and decodes to and from Base64 notation.

*

Homepage: http://iharder.net/base64.

- *

+ * *

Example:

- *

+ * * String encoded = Base64.encode( myByteArray ); *
* byte[] myByteArray = Base64.decode( encoded ); - *

+ * *

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, * and encoding using the URL-safe and Ordered dialects.

- *

+ * *

Note, according to RFC3548, * Section 2.1, implementations should not add line feeds unless explicitly told * to do so. I've got Base64 set to this behavior now, although earlier versions * broke lines by default.

- *

+ * *

The constants defined in Base64 can be OR-ed together to combine options, so you * might make a call like this:

- *

+ * * String encoded = Base64.encodeBytes( mybytes, Base64.GZIP | Base64.DO_BREAK_LINES ); *

to compress the data before encoding it and then making the output have newline characters.

*

Also...

* String encoded = Base64.encodeBytes( crazyString.getBytes() ); - *

- *

- *

+ * + * + * *

* Change Log: *

@@ -95,7 +95,7 @@ package cli; * Special thanks to Jim Kellerman at http://www.powerset.com/ * for contributing the new Base64 dialects. * - *

+ * *

  • v2.1 - Cleaned up javadoc comments and unused variables and methods. Added * some convenience methods for reading and writing to and from files.
    • *
  • v2.0.2 - Now specifies UTF-8 encoding in places where the code fails on systems @@ -123,7 +123,7 @@ package cli; *
  • v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
    • *
  • v1.3.3 - Fixed I/O streams which were totally messed up.
    • * - *

    + * *

    * I am placing this code in the Public Domain. Do with it as you will. * This software comes with no guarantees or warranties but with @@ -619,13 +619,13 @@ public class Base64 { /** * Serializes an object and returns the Base64-encoded * version of that serialized object. - *

    + * *

    As of v 2.3, if the object * cannot be serialized or there is another error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned a null value, but * in retrospect that's a pretty poor way to handle it.

    - *

    + * * The object is not GZip-compressed before being encoded. * * @param serializableObject The object to encode @@ -643,22 +643,22 @@ public class Base64 { /** * Serializes an object and returns the Base64-encoded * version of that serialized object. - *

    + * *

    As of v 2.3, if the object * cannot be serialized or there is another error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned a null value, but * in retrospect that's a pretty poor way to handle it.

    - *

    + * * The object is not GZip-compressed before being encoded. - *

    + * * Example options:

          *   GZIP: gzip-compresses object before encoding it.
      *   DO_BREAK_LINES: break lines at 76 characters
      *
    - *

    + * * Example: encodeObject( myObj, Base64.GZIP ) or - *

    + * * Example: encodeObject( myObj, Base64.GZIP | Base64.DO_BREAK_LINES ) * * @param serializableObject The object to encode @@ -793,8 +793,8 @@ public class Base64 { * Example: encodeBytes( myData, Base64.GZIP ) or *

    * Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES ) - *

    - *

    + * + * *

    As of v 2.3, if there is an error with the GZIP stream, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned a null value, but @@ -817,7 +817,7 @@ public class Base64 { /** * Encodes a byte array into Base64 notation. * Does not GZip-compress data. - *

    + * *

    As of v 2.3, if there is an error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned a null value, but @@ -858,8 +858,8 @@ public class Base64 { * Example: encodeBytes( myData, Base64.GZIP ) or *

    * Example: encodeBytes( myData, Base64.GZIP | Base64.DO_BREAK_LINES ) - *

    - *

    + * + * *

    As of v 2.3, if there is an error with the GZIP stream, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned a null value, but @@ -1455,7 +1455,7 @@ public class Base64 { /** * Convenience method for encoding data to a file. - *

    + * *

    As of v 2.3, if there is a error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned false, but @@ -1495,7 +1495,7 @@ public class Base64 { /** * Convenience method for decoding data to a file. - *

    + * *

    As of v 2.3, if there is a error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned false, but @@ -1531,7 +1531,7 @@ public class Base64 { /** * Convenience method for reading a base64-encoded * file and decoding it. - *

    + * *

    As of v 2.3, if there is a error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned false, but @@ -1592,7 +1592,7 @@ public class Base64 { /** * Convenience method for reading a binary file * and base64-encoding it. - *

    + * *

    As of v 2.3, if there is a error, * the method will throw an java.io.IOException. This is new to v2.3! * In earlier versions, it just returned false, but @@ -1740,13 +1740,13 @@ public class Base64 { /** * Constructs a {@link Base64.InputStream} in * either ENCODE or DECODE mode. - *

    + * * Valid options:

              *   ENCODE or DECODE: Encode or Decode as data is read.
          *   DO_BREAK_LINES: break lines at 76 characters
          *     (only meaningful when encoding)
          *
    - *

    + * * Example: new Base64.InputStream( in, Base64.DECODE ) * * @param in the java.io.InputStream from which to read data. @@ -1951,13 +1951,13 @@ public class Base64 { /** * Constructs a {@link Base64.OutputStream} in * either ENCODE or DECODE mode. - *

    + * * Valid options:

              *   ENCODE or DECODE: Encode or Decode as data is read.
          *   DO_BREAK_LINES: don't break lines at 76 characters
          *     (only meaningful when encoding)
          *
    - *

    + * * Example: new Base64.OutputStream( out, Base64.ENCODE ) * * @param out the java.io.OutputStream to which data will be written. diff --git a/src/main/java/cli/Main.java b/src/main/java/cli/Main.java index f6b6bb70..8a6cea53 100644 --- a/src/main/java/cli/Main.java +++ b/src/main/java/cli/Main.java @@ -1,16 +1,16 @@ /** * Copyright (C) 2015 AsamK - *

    + * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. - *

    + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - *

    + * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ diff --git a/src/main/java/cli/Manager.java b/src/main/java/cli/Manager.java index 7fe551a4..177cae78 100644 --- a/src/main/java/cli/Manager.java +++ b/src/main/java/cli/Manager.java @@ -1,16 +1,16 @@ /** * Copyright (C) 2015 AsamK - *

    + * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. - *

    + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - *

    + * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */