[commons-io] 01/03: Javadoc.

[gg...@apache.org]

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-io.git

commit 3418d095f20a856f9d4de5bb1c976a8104acde45
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Sep 3 12:43:50 2021 -0400

    Javadoc.
---
 src/main/java/org/apache/commons/io/FilenameUtils.java | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java b/src/main/java/org/apache/commons/io/FilenameUtils.java
index 7ef31cc..b577748 100644
--- a/src/main/java/org/apache/commons/io/FilenameUtils.java
+++ b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -453,35 +453,43 @@ public class FilenameUtils {
      * The effect is equivalent to resultant directory after changing
      * directory to the first argument, followed by changing directory to
      * the second argument.
+     * </p>
      * <p>
      * The first argument is the base path, the second is the path to concatenate.
      * The returned path is always normalized via {@link #normalize(String)},
      * thus {@code ..} is handled.
+     * </p>
      * <p>
      * If {@code pathToAdd} is absolute (has an absolute prefix), then
      * it will be normalized and returned.
      * Otherwise, the paths will be joined, normalized and returned.
+     * </p>
      * <p>
      * The output will be the same on both Unix and Windows except
      * for the separator character.
+     * </p>
      * <pre>
      * /foo/      + bar        --&gt;  /foo/bar
      * /foo       + bar        --&gt;  /foo/bar
      * /foo       + /bar       --&gt;  /bar
      * /foo       + C:/bar     --&gt;  C:/bar
-     * /foo       + C:bar      --&gt;  C:bar (*)
+     * /foo       + C:bar      --&gt;  C:bar [1]
      * /foo/a/    + ../bar     --&gt;  /foo/bar
      * /foo/      + ../../bar  --&gt;  null
      * /foo/      + /bar       --&gt;  /bar
      * /foo/..    + /bar       --&gt;  /bar
      * /foo       + bar/c.txt  --&gt;  /foo/bar/c.txt
-     * /foo/c.txt + bar        --&gt;  /foo/c.txt/bar (!)
+     * /foo/c.txt + bar        --&gt;  /foo/c.txt/bar [2]
      * </pre>
-     * (*) Note that the Windows relative drive prefix is unreliable when
+     * <p>
+     * [1] Note that the Windows relative drive prefix is unreliable when
      * used with this method.
-     * (!) Note that the first parameter must be a path. If it ends with a name, then
+     * </p>
+     * <p>
+     * [2] Note that the first parameter must be a path. If it ends with a name, then
      * the name will be built into the concatenated path. If this might be a problem,
      * use {@link #getFullPath(String)} on the base path argument.
+     * </p>
      *
      * @param basePath  the base path to attach to, always treated as a path
      * @param fullFileNameToAdd  the fileName (or path) to attach to the base