Javadoc fixes

Author: Suszyński Krzysztof

src/main/java/pl/wavesoftware/eid/exceptions/Eid.java

@@ -162,8 +162,7 @@ public static String setRefFormat(String refFormat) {
     /**
      * Makes a log message from this EID object
      * <p>
-     * <p>This method is for convenience of usage of EID in logging. You can use it like this:
-     * <p>
+     * This method is for convenience of usage of EID in logging. You can use it like this:
      * <pre>
      * log.debug(new Eid("20151025:202129").makeLogMessage("A request: %s", request));
      * </pre>

src/main/java/pl/wavesoftware/eid/exceptions/EidRuntimeException.java

@@ -54,13 +54,13 @@ public EidRuntimeException(String eid, String ref) {
     }
 
     /**
-     * Constructs a new runtime exception with the specified cause, a exception Id and detail message of <tt>eid.toString() + " =>
-     * " + (cause==null ? null : cause.toString())</tt>
-     * (which typically contains the class and detail message of
-     * <tt>cause</tt>). This constructor is useful for runtime exceptions that are little more than wrappers for other throwable.
+     * Constructs a new runtime exception with the specified cause, a exception Id and detail message of
+     * <code>eid.toString() + " =&gt; " + (cause==null ? null : cause.toString())</code> (which typically contains
+     * the class and detail message of <code>cause</code>). This constructor is useful for runtime exceptions
+     * that are little more than wrappers for other throwable.
      *
      * @param eid exception ID
-     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <tt>null</tt>
+     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <code>null</code>
      * value is permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public EidRuntimeException(String eid, Throwable cause) {
@@ -72,7 +72,7 @@ public EidRuntimeException(String eid, Throwable cause) {
      *
      * @param eid exception ID
      * @param ref the ref code for Eid
-     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <tt>null</tt> value is
+     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <code>null</code> value is
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public EidRuntimeException(String eid, String ref, Throwable cause) {
@@ -92,10 +92,10 @@ public EidRuntimeException(Eid id) {
     /**
      * Constructs a new runtime exception with the specified Eid object and cause
      * <p>
-     * The detail message is computed as <tt>String.format(Eid.getMessageFormat(), id.toString(), message(cause))</tt>
+     * The detail message is computed as <code>String.format(Eid.getMessageFormat(), id.toString(), message(cause))</code>
      *
      * @param id exception ID
-     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <tt>null</tt> value is
+     * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <code>null</code> value is
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public EidRuntimeException(Eid id, Throwable cause) {

src/main/java/pl/wavesoftware/eid/utils/EidPreconditions.java

@@ -27,81 +27,72 @@
 import javax.annotation.Nullable;
 
 /**
- * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
- * <p/>
+ * <p>
+ * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house
+ * development of end user applications which will report Bugs in standardized error pages or post them to issue
+ * tracker.
+ * <p>
  * Static convenience methods that help a method or constructor check whether it was invoked correctly (whether its
- * <i>preconditions</i>
- * have been met). These methods generally accept a {@code boolean} expression which is expected to be {@code true} (or in the
- * case of {@code
- * checkNotNull}, an object reference which is expected to be non-null). When {@code false} (or {@code null}) is passed instead,
- * the {@code EidPreconditions} method throws an unchecked exception, which helps the calling method communicate to <i>its</i>
- * caller that
- * <i>that</i> caller has made a mistake.
- * <p/>
- * Each method accepts a EID String or {@link Eid} object, which is designed to ease of use and provide strict ID for given
- * Exception usage. This approach speed up development of large application and helps support teams to by giving the both static
- * and random ID for each possible unpredicted bug.
- * <p/>
+ * <i>preconditions</i> have been met). These methods generally accept a {@code boolean} expression which is expected
+ * to be {@code true} (or in the case of {@link #checkNotNull(Object, String)}, an object reference which is expected
+ * to be non-null). When {@code false} (or {@code null}) is passed instead, the {@link EidPreconditions} method throws
+ * an unchecked exception, which helps the calling method communicate to <i>its</i> caller <i>that</i> caller has made
+ * a mistake.
+ * <p>
+ * Each method accepts a EID String or {@link Eid} object, which is designed to ease of use and provide strict ID for
+ * given Exception usage. This approach speed up development of large application and helps support teams to by giving
+ * the both static and random ID for each possible unpredicted bug.
+ * <p>
  * This is best to use with tools and plugins like
  * <a href="http://plugins.netbeans.org/plugin/53137/exception-id-eid-generator">EidGenerator for Netbeans IDE</a>
- * <p/>
+ * <p>
  * Example:
- * <pre>   {@code
- *
- *   /**
- *    * Returns the positive square root of the given value.
- *    *
- *    * @throws EidIllegalArgumentException if the value is negative
- *    *}{@code /
- *   public static double sqrt(double value) {
- *     EidPreconditions.checkArgument(value >= 0.0, "20150718:012333");
+ * <pre>
+ * &#47;**
+ *  * Returns the positive square root of the given value.
+ *  *
+ *  * &#64;throws EidIllegalArgumentException if the value is negative
+ *  *&#47;
+ * public static double sqrt(double value) {
+ *     EidPreconditions.checkArgument(value &gt;= 0.0, "20150718:012333");
  *     // calculate the square root
- *   }
+ * }
  *
- *   void exampleBadCaller() {
+ * void exampleBadCaller() {
  *     double d = sqrt(-1.0);
- *   }
- * }</pre>
- * <p/>
- * In this example, {@code checkArgument} throws an {@code EidIllegalArgumentException} to indicate that {@code exampleBadCaller}
- * made an error in <i>its</i> call to {@code sqrt}. Exception, when it will be printed will contain user given Eid and also
- * Randomly generated ID. Those fields can be displayed to user on error page on posted directly to issue tracker.
- * <p/>
+ * }
+ * </pre>
+ * <p>
+ * In this example, {@link #checkArgument(boolean, String)} throws an {@link EidIllegalArgumentException} to indicate
+ * that {@code exampleBadCaller} made an error in <i>its</i> call to {@code sqrt}. Exception, when it will be printed
+ * will contain user given Eid and also randomly generated ID. Those fields can be displayed to user on error page on
+ * posted directly to issue tracker.
+ * <p>
  * Example:
- * <p/>
  * <pre>
- *
- * {@code
- *   // Main application class for ex.: http servlet
- *    try {
- *        performRequest(request, response);
- *    } catch (EidRuntimeException ex) {
- *        issuesTracker.put(ex);
- *        throw ex;
- *    }
- * }</pre>
- * <p/>
- * <p/>
+ * // Main application class for ex.: http servlet
+ * try {
+ *     performRequest(request, response);
+ * } catch (EidRuntimeException ex) {
+ *     issuesTracker.put(ex);
+ *     throw ex;
+ * }
+ * </pre>
  * <h3>Functional try to execute blocks</h3>
- * <p/>
- * <p/>
  * Using functional blocks to handle operations, that are intended to operate properly, simplify the code and makes it more
  * readable. It's also good way to deal with untested, uncovered {@code catch} blocks. It's easy and gives developers nice way of
  * dealing with countless operations that suppose to work as intended.
- * <p/>
- * <p/>
+ * <p>
  * Example:
- * <pre><code>
- *
- *     InputStream is = EidPreconditions.tryToExecute({@code new UnsafeSupplier<InputStream>}() {
- *        {@literal @}Override
- *         public InputStream get() throws IOException {
- *             return this.getClass().getClassLoader()
- *                 .getResourceAsStream("project.properties");
- *         }
- *     }, "20150718:121521");
- * </code></pre>
+ * <pre>
+ * InputStream is = EidPreconditions.tryToExecute(new UnsafeSupplier&lt;InputStream&gt;() {
+ *     &#64;Override
+ *     public InputStream get() throws IOException {
+ *         return this.getClass().getClassLoader()
+ *             .getResourceAsStream("project.properties");
+ *     }
+ * }, "20150718:121521");
+ * </pre>
  *
  * @author <a href="mailto:[email protected]">Krzysztof Suszynski</a>
  * @since 0.1.0 (idea imported from Guava Library and COI code)
@@ -450,18 +441,17 @@ public static void tryToExecute(final UnsafeProcedure procedure, final String ei
     /**
      * Tries to execute code in given unsafe supplier code block, and if exception is thrown, it will gets rethrown as a
      * {@link EidRuntimeException} with eid given as a argument. This is because this exception is threaded as a software bug!
-     * <p/>
+     * <p>
      * Example:
-     * <pre><code>
-     *
-     * Document doc = EidPreconditions.tryToExecute({@code new UnsafeSupplier<Document>}() {
-     *    {@literal @}Override
+     * <pre>
+     * Document doc = EidPreconditions.tryToExecute(new UnsafeSupplier&lt;Document&gt;}() {
+     *     &#64;Override
      *     public Document get() throws SAXException, IOException {
-     *          DocumentBuilder docBuilder = ...
-     *          return docBuilder.parse(new InputSource(reader));
+     *         DocumentBuilder docBuilder = ...
+     *         return docBuilder.parse(new InputSource(reader));
      *     }
      * }, new Eid("20150718:121521"));
-     * </code></pre>
+     * </pre>
      *
      * @param <R>      return type
      * @param supplier unsafe supplier code to be executed within a try-catch block
@@ -480,17 +470,16 @@ public static <R> R tryToExecute(final UnsafeSupplier<R> supplier, final Eid eid
     /**
      * Tries to execute code in given unsafe procedure code block, and if exception is thrown, it will gets rethrown as a
      * {@link EidRuntimeException} with eid given as a argument. This is because this exception is threaded as a software bug!
-     * <p/>
+     * <p>
      * Example:
-     * <pre><code>
-     *
-     * EidPreconditions.tryToExecute({@code new UnsafeProcedure}() {
-     *    {@literal @}Override
+     * <pre>
+     * EidPreconditions.tryToExecute(new UnsafeProcedure() {
+     *     &#64;Override
      *     public void execute() throws EJBException {
-     *          em.persist(user);
+     *         em.persist(user);
      *     }
      * }, new Eid("20151117:184627"));
-     * </code></pre>
+     * </pre>
      *
      * @param procedure unsafe procedure code to be executed within a try-catch block
      * @param eid       unique developer identifier from date for ex.: "20150716:123200"