From 63391074baa84256f2e66fcef0ce02a686a960ea Mon Sep 17 00:00:00 2001
From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Wed, 3 Feb 2016 21:30:26 -0500
Subject: [PATCH] Fix javadoc formatting issues

- Fix javadoc '<' and '>' to &lt; and &gt; escape characters
- Add missing @throws

Change-Id: Idcbc8217f931de655e38687df6a89cc94b346cb2
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---
 .../model/util/SchemaContextProxyTest.java    | 26 +++++++++----------
 .../parser/builder/impl/BuilderUtilsTest.java |  2 +-
 .../parser/builder/impl/CopyUtilsTest.java    |  2 +-
 .../impl/LeafListSchemaNodeBuilderTest.java   |  2 +-
 .../builder/impl/ModuleBuilderTest.java       |  2 +-
 .../parser/builder/impl/RefineUtilsTest.java  |  2 +-
 .../impl/RpcDefinitionBuilderTest.java        |  2 +-
 .../impl/ParsingExtensionValueTest.java       |  2 +-
 .../yang/parser/impl/UsesAugmentTest.java     |  2 ++
 .../retest/ParsingExtensionValueTest.java     |  2 +-
 .../yang/stmt/retest/UsesAugmentTest.java     |  2 ++
 11 files changed, 25 insertions(+), 21 deletions(-)

diff --git a/yang/yang-model-util/src/test/java/org/opendaylight/yangtools/yang/model/util/SchemaContextProxyTest.java b/yang/yang-model-util/src/test/java/org/opendaylight/yangtools/yang/model/util/SchemaContextProxyTest.java
index 8be97cddd7..5fd9c37364 100644
--- a/yang/yang-model-util/src/test/java/org/opendaylight/yangtools/yang/model/util/SchemaContextProxyTest.java
+++ b/yang/yang-model-util/src/test/java/org/opendaylight/yangtools/yang/model/util/SchemaContextProxyTest.java
@@ -64,7 +64,7 @@ public class SchemaContextProxyTest {
      * CFG(R)
      *  | \
      *  |  \
-     * M2 <- M3
+     * M2 &lt;- M3
      * </pre>
      */
     @Test
@@ -87,7 +87,7 @@ public class SchemaContextProxyTest {
      * No root or additional modules
      *  | \
      *  |  \
-     * M2 <- M3
+     * M2 &lt;- M3
      * </pre>
      */
     @Test
@@ -110,7 +110,7 @@ public class SchemaContextProxyTest {
      *  Config
      *  | \ (NR)
      *  |  \
-     * M2 <- M3
+     * M2 &lt;- M3
      * </pre>
      */
     @Test
@@ -135,7 +135,7 @@ public class SchemaContextProxyTest {
      *     CFG(R)
      *    |      \
      *   |         \
-     * M2<-(NullRev)M3
+     * M2&lt;-(NullRev)M3
      * </pre>
      */
     @Test
@@ -187,7 +187,7 @@ public class SchemaContextProxyTest {
      * CFG(R)
      *  |
      *  |
-     * M2 <- M3
+     * M2 &lt;- M3
      * </pre>
      */
     @Test
@@ -210,7 +210,7 @@ public class SchemaContextProxyTest {
      * CFG(R)
      *  |
      *  |
-     * M2 -> M3 -> M4 -> M5
+     * M2 -&gt; M3 -&gt; M4 -&gt; M5
      * </pre>
      */
     @Test
@@ -236,7 +236,7 @@ public class SchemaContextProxyTest {
      * CFG(R)
      *  |
      *  |
-     * M2 -> M3 <- M4
+     * M2 -&gt; M3 &lt;- M4
      * </pre>
      */
     @Test
@@ -287,7 +287,7 @@ public class SchemaContextProxyTest {
      * CFG(R)
      *  | \
      *  |  \
-     * M2 <- M3 M4=M3(Different revision)
+     * M2 &lt;- M3 M4=M3(Different revision)
      * </pre>
      */
     @Test
@@ -312,7 +312,7 @@ public class SchemaContextProxyTest {
      * <pre>
      * CFG(R)
      * |
-     * M2 -(no revision)-> M3(R2) ... M3(R1)
+     * M2 -(no revision)-&gt; M3(R2) ... M3(R1)
      * </pre>
      */
     @Test
@@ -337,9 +337,9 @@ public class SchemaContextProxyTest {
      * CFG(R)
      * |   \
      * |    \
-     * |    M2 -> M3
+     * |    M2 -&gt; M3
      * |
-     * M41(S) => M4
+     * M41(S) =&gt; M4
      * </pre>
      */
     @Test
@@ -363,7 +363,7 @@ public class SchemaContextProxyTest {
     /**
      * <pre>
      *
-     * M2 -> M3 -> M4 -> M5
+     * M2 -&gt; M3 -&gt; M4 -&gt; M5
      *
      * </pre>
      */
@@ -392,7 +392,7 @@ public class SchemaContextProxyTest {
      *  |       M5
      * M2
      *
-     * M3 -> M4
+     * M3 -&gt; M4
      *
      * </pre>
      */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtilsTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtilsTest.java
index 70d82524cf..7573e934a5 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtilsTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/BuilderUtilsTest.java
@@ -47,7 +47,7 @@ import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  *
  * @see org.opendaylight.yangtools.yang.parser.builder.impl.BuilderUtils
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  *
  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/CopyUtilsTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/CopyUtilsTest.java
index 06a2af7928..5edc74719c 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/CopyUtilsTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/CopyUtilsTest.java
@@ -33,7 +33,7 @@ import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  *
  * @see org.opendaylight.yangtools.yang.parser.builder.impl.CopyUtils
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  *
  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/LeafListSchemaNodeBuilderTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/LeafListSchemaNodeBuilderTest.java
index 586239ba06..54d511bb0d 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/LeafListSchemaNodeBuilderTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/LeafListSchemaNodeBuilderTest.java
@@ -26,7 +26,7 @@ import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuild
  *
  * @see org.opendaylight.yangtools.yang.parser.builder.impl.LeafListSchemaNodeBuilder
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  *
  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/ModuleBuilderTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/ModuleBuilderTest.java
index ffb9c8abf6..07360bed09 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/ModuleBuilderTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/ModuleBuilderTest.java
@@ -32,7 +32,7 @@ import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  *
  * @see org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  *
  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RefineUtilsTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RefineUtilsTest.java
index f80a7f2735..3c43ecf02b 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RefineUtilsTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RefineUtilsTest.java
@@ -24,7 +24,7 @@ import org.opendaylight.yangtools.yang.parser.util.YangParseException;
  *
  * @see org.opendaylight.yangtools.yang.parser.builder.impl.RefineUtils
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  *
  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RpcDefinitionBuilderTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RpcDefinitionBuilderTest.java
index 6c756d4c5e..56b6a181d2 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RpcDefinitionBuilderTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/builder/impl/RpcDefinitionBuilderTest.java
@@ -26,7 +26,7 @@ import org.opendaylight.yangtools.yang.parser.builder.api.UnknownSchemaNodeBuild
  *
  * @see org.opendaylight.yangtools.yang.parser.builder.impl.RpcDefinitionBuilder
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  *
  * @deprecated Pre-Beryllium implementation, scheduled for removal.
  */
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/ParsingExtensionValueTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/ParsingExtensionValueTest.java
index 07b008dfc0..404b208203 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/ParsingExtensionValueTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/ParsingExtensionValueTest.java
@@ -19,7 +19,7 @@ import org.opendaylight.yangtools.yang.model.api.Module;
 /**
  * Test for testing of extensions and their arguments.
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  */
 public class ParsingExtensionValueTest {
 
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/UsesAugmentTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/UsesAugmentTest.java
index 6c4e1bfc68..48ce134171 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/UsesAugmentTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/UsesAugmentTest.java
@@ -111,6 +111,8 @@ public class UsesAugmentTest {
      * |-- |-- leaf ignore (U)
      *
      * U = added by uses A = added by augment
+     *
+     * @throws Exception if exception occurs
      */
     @Test
     public void testAugmentInUses() throws Exception {
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/ParsingExtensionValueTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/ParsingExtensionValueTest.java
index 5ecd311caa..01704fc2eb 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/ParsingExtensionValueTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/ParsingExtensionValueTest.java
@@ -15,7 +15,7 @@ import org.junit.Test;
 /**
  * Test for testing of extensions and their arguments.
  *
- * @author Lukas Sedlak <lsedlak@cisco.com>
+ * @author Lukas Sedlak &lt;lsedlak@cisco.com&gt;
  */
 public class ParsingExtensionValueTest {
 
diff --git a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/UsesAugmentTest.java b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/UsesAugmentTest.java
index 4adb610e43..4adc20e38e 100644
--- a/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/UsesAugmentTest.java
+++ b/yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/stmt/retest/UsesAugmentTest.java
@@ -108,6 +108,8 @@ public class UsesAugmentTest {
      * |-- |-- leaf ignore (U)
      *
      * U = added by uses A = added by augment
+     *
+     * @throws Exception if exception occurs
      */
     @Test
     public void testAugmentInUses() throws Exception {
-- 
2.36.6