From: Robert Varga <robert.varga@pantheon.tech>
Date: Thu, 20 Aug 2020 09:35:23 +0000 (+0200)
Subject: Correct (Un)qualifiedQName javadoc
X-Git-Tag: v6.0.0~84
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=ed4fc2d7195ad18fa5c8a8d085a25f0f428e5c41;p=yangtools.git

Correct (Un)qualifiedQName javadoc

This adds a bit of documentation and correcting a mitsaken @return.

Change-Id: I56ed5aa57969fad5230c8b3a30503f162888ee22
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---

diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java
index 72be15e045..1c12ecb4cf 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/QualifiedQName.java
@@ -44,11 +44,11 @@ public final class QualifiedQName extends AbstractQName implements Comparable<Qu
     }
 
     /**
-     * Read an UnboundQName from a DataInput. The format is expected to match the output format of
+     * Read an QualifiedQName from a DataInput. The format is expected to match the output format of
      * {@link #writeTo(DataOutput)}.
      *
      * @param in DataInput to read
-     * @return An UnboundQName instance
+     * @return An QualifiedQName instance
      * @throws IOException if I/O error occurs
      */
     public static QualifiedQName readFrom(final DataInput in) throws IOException {
diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java
index 6d0bc42b0e..c596dd86b2 100644
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/UnqualifiedQName.java
@@ -32,16 +32,23 @@ public final class UnqualifiedQName extends AbstractQName implements Comparable<
         super(localName);
     }
 
+    /**
+     * Create a new unqualified QName.
+     *
+     * @param localName The local name of this unqualified QName
+     * @return An UnqualifiedQName instance
+     * @throws IllegalArgumentException if localName is null or it does not conform to YANG localName requirements.
+     */
     public static UnqualifiedQName of(final String localName) {
         return new UnqualifiedQName(checkLocalName(localName));
     }
 
     /**
-     * Read an UnboundQName from a DataInput. The format is expected to match the output format of
+     * Read an UnqualifiedQName from a DataInput. The format is expected to match the output format of
      * {@link #writeTo(DataOutput)}.
      *
      * @param in DataInput to read
-     * @return An UnboundQName instance
+     * @return An UnqualifiedQName instance
      * @throws IOException if I/O error occurs
      */
     public static UnqualifiedQName readFrom(final DataInput in) throws IOException {