You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@any23.apache.org by le...@apache.org on 2017/01/19 05:07:04 UTC

any23 git commit: Fix trivial Javadoc issues

Repository: any23
Updated Branches:
  refs/heads/master a5f24cbbf -> be133d068


Fix trivial Javadoc issues


Project: http://git-wip-us.apache.org/repos/asf/any23/repo
Commit: http://git-wip-us.apache.org/repos/asf/any23/commit/be133d06
Tree: http://git-wip-us.apache.org/repos/asf/any23/tree/be133d06
Diff: http://git-wip-us.apache.org/repos/asf/any23/diff/be133d06

Branch: refs/heads/master
Commit: be133d0683c6d435eaf72cdac77828ec8529c6ac
Parents: a5f24cb
Author: Lewis John McGibbney <le...@gmail.com>
Authored: Wed Jan 18 21:06:57 2017 -0800
Committer: Lewis John McGibbney <le...@gmail.com>
Committed: Wed Jan 18 21:06:57 2017 -0800

----------------------------------------------------------------------
 api/src/main/java/org/apache/any23/vocab/YAML.java        | 9 +++++----
 core/src/main/java/org/apache/any23/util/StringUtils.java | 8 ++++----
 2 files changed, 9 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/any23/blob/be133d06/api/src/main/java/org/apache/any23/vocab/YAML.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/any23/vocab/YAML.java b/api/src/main/java/org/apache/any23/vocab/YAML.java
index 5cb409c..41df328 100644
--- a/api/src/main/java/org/apache/any23/vocab/YAML.java
+++ b/api/src/main/java/org/apache/any23/vocab/YAML.java
@@ -50,9 +50,9 @@ public class YAML extends Vocabulary {
 	}
 
 	/**
-	 * The root node. Representation of the YAML file. NB: one file may contain more than one documents
-	 * represented by nodes; e.g. <br/>
-	 * <br/>
+	 * <p>The root node. Representation of the YAML file. NB: one file may contain more than one documents
+	 * represented by nodes; e.g. </p>
+	 * <p>
 	 * <code>
 	 * %YAML 1.2 
 	 * --- 
@@ -60,7 +60,8 @@ public class YAML extends Vocabulary {
 	 * - data2 
 	 * --- 
 	 * - data3 
-	 * </code> <br/>
+	 * </code>
+	 * </p>
 	 * Contains two documents.
 	 */
 	public final IRI root = createProperty(NS, ROOT);

http://git-wip-us.apache.org/repos/asf/any23/blob/be133d06/core/src/main/java/org/apache/any23/util/StringUtils.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/any23/util/StringUtils.java b/core/src/main/java/org/apache/any23/util/StringUtils.java
index 58273c2..e9c2494 100644
--- a/core/src/main/java/org/apache/any23/util/StringUtils.java
+++ b/core/src/main/java/org/apache/any23/util/StringUtils.java
@@ -181,14 +181,14 @@ public class StringUtils {
     /**
      * Changes string with following convention:
      * <ul>
-     * <li>Changes '-' -> '_'
+     * <li>Changes '-' -&gt; '_'
      * <li>remove space characters and make first letter word uppercase: 'some
-     * string' -> 'someString'
+     * string' -&gt; 'someString'
      * </ul>
      * If input string does not contains a whitespace than return unchanged.
      *
-     * @param in
-     * @return
+     * @param in an input string to convert to Java code convention
+     * @return the correctly formatter string as per Java spec.
      */
     public static String implementJavaNaming(String in) {