You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2020/02/17 14:58:28 UTC

[commons-lang] branch master updated: JavaDoc was modified adding {@code around pre formatted text so there is no need for HTML escape sequences (#490)

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git


The following commit(s) were added to refs/heads/master by this push:
     new 80839be  JavaDoc was modified adding {@code around pre formatted text so there is no need for HTML escape sequences (#490)
80839be is described below

commit 80839be4577e298335a1d3887518bf1ef4455f64
Author: Peter Verhas <pe...@verhas.com>
AuthorDate: Mon Feb 17 15:58:19 2020 +0100

    JavaDoc was modified adding {@code around pre formatted text so there is no need for HTML escape sequences (#490)
---
 .../java/org/apache/commons/lang3/Functions.java   | 24 +++++++++++-----------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/commons/lang3/Functions.java b/src/main/java/org/apache/commons/lang3/Functions.java
index 91b4c9a..e7808ac 100644
--- a/src/main/java/org/apache/commons/lang3/Functions.java
+++ b/src/main/java/org/apache/commons/lang3/Functions.java
@@ -40,21 +40,21 @@ import org.apache.commons.lang3.Streams.FailableStream;
  * More specifically, it attempts to address the fact that lambdas are supposed
  * not to throw Exceptions, at least not checked Exceptions, aka instances of
  * {@link Exception}. This enforces the use of constructs like
- * <pre>
- *   Consumer&lt;java.lang.reflect.Method&gt; consumer = (m) -&gt; {
+ * <pre>{@code
+ *   Consumer<java.lang.reflect.Method> consumer = (m) -> {
  *       try {
  *           m.invoke(o, args);
  *       } catch (Throwable t) {
  *           throw Functions.rethrow(t);
  *       }
  *   };
- * </pre>
+ * }</pre>
  * By replacing a {@link java.util.function.Consumer Consumer&lt;O&gt;} with a
  * {@link FailableConsumer FailableConsumer&lt;O,? extends Throwable&gt;}, this can be
  * written like follows:
- * <pre>
- *   Functions.accept((m) -&gt; m.invoke(o,args));
- * </pre>
+ * <pre>{@code
+ *   Functions.accept((m) -> m.invoke(o,args));
+ * }</pre>
  * Obviously, the second version is much more concise and the spirit of
  * Lambda expressions is met better than the second version.
  */
@@ -446,10 +446,10 @@ public class Functions {
      * and regardless of success, or failure. If either the original action, or
      * any of the resource action fails, then the <em>first</em> failure (aka
      * {@link Throwable} is rethrown. Example use:
-     * <pre>
+     * <pre>{@code
      *   final FileInputStream fis = new FileInputStream("my.file");
-     *   Functions.tryWithResources(useInputStream(fis), null, () -&gt; fis.close());
-     * </pre>
+     *   Functions.tryWithResources(useInputStream(fis), null, () -> fis.close());
+     * }</pre>
      * @param pAction The action to execute. This object <em>will</em> always
      *   be invoked.
      * @param pErrorHandler An optional error handler, which will be invoked finally,
@@ -509,10 +509,10 @@ public class Functions {
      * and regardless of success, or failure. If either the original action, or
      * any of the resource action fails, then the <em>first</em> failure (aka
      * {@link Throwable} is rethrown. Example use:
-     * <pre>
+     * <pre>{@code
      *   final FileInputStream fis = new FileInputStream("my.file");
-     *   Functions.tryWithResources(useInputStream(fis), () -&gt; fis.close());
-     * </pre>
+     *   Functions.tryWithResources(useInputStream(fis), () -> fis.close());
+     * }</pre>
      * @param pAction The action to execute. This object <em>will</em> always
      *   be invoked.
      * @param pResources The resource actions to execute. <em>All</em> resource