Coding gudilines for class and methods javadocs fixed.
Change-Id: I0153e6391c9ec9eacaac65c3989834b6bf5c65bf
diff --git a/src/main/java/org/onosproject/yangutils/datamodel/utils/DataModelUtils.java b/src/main/java/org/onosproject/yangutils/datamodel/utils/DataModelUtils.java
index 9c3e5ec..76e8f36 100644
--- a/src/main/java/org/onosproject/yangutils/datamodel/utils/DataModelUtils.java
+++ b/src/main/java/org/onosproject/yangutils/datamodel/utils/DataModelUtils.java
@@ -17,6 +17,7 @@
package org.onosproject.yangutils.datamodel.utils;
import java.util.List;
+
import org.onosproject.yangutils.datamodel.CollisionDetector;
import org.onosproject.yangutils.datamodel.HasResolutionInfo;
import org.onosproject.yangutils.datamodel.YangLeaf;
@@ -28,7 +29,7 @@
import org.onosproject.yangutils.utils.YangConstructType;
/**
- * Utilities for data model tree.
+ * Represents utilities for data model tree.
*/
public final class DataModelUtils {
@@ -49,6 +50,7 @@
*/
public static void detectCollidingChildUtil(String identifierName, YangConstructType dataType, YangNode node)
throws DataModelException {
+
if (dataType == YangConstructType.LEAF_DATA) {
YangLeavesHolder leavesHolder = (YangLeavesHolder) node;
if (leavesHolder.getListOfLeaf() != null) {
@@ -78,8 +80,9 @@
* checked
* @throws DataModelException a violation of data model rules
*/
- private static void detectCollidingLeaf(YangLeavesHolder leavesHolder, String identifierName) throws
- DataModelException {
+ private static void detectCollidingLeaf(YangLeavesHolder leavesHolder, String identifierName)
+ throws DataModelException {
+
for (YangLeaf leaf : leavesHolder.getListOfLeaf()) {
if (leaf.getLeafName().equals(identifierName)) {
throw new DataModelException("YANG file error: Duplicate input identifier detected, same as leaf \""
@@ -96,8 +99,9 @@
* checked
* @throws DataModelException a violation of data model rules
*/
- private static void detectCollidingLeafList(YangLeavesHolder leavesHolder, String identifierName) throws
- DataModelException {
+ private static void detectCollidingLeafList(YangLeavesHolder leavesHolder, String identifierName)
+ throws DataModelException {
+
for (YangLeafList leafList : leavesHolder.getListOfLeafList()) {
if (leafList.getLeafName().equals(identifierName)) {
throw new DataModelException("YANG file error: Duplicate input identifier detected, same as leaf " +
@@ -114,6 +118,7 @@
* @throws DataModelException a violation of data model rules
*/
public static void addResolutionInfo(YangResolutionInfo resolutionInfo) throws DataModelException {
+
/* get the module node to add maintain the list of nested reference */
YangNode curNode = resolutionInfo.getHolderOfEntityToResolve();
while (!(curNode instanceof HasResolutionInfo)) {
@@ -134,8 +139,9 @@
* @throws DataModelException a violation of data model rules
*/
public static void resolveLinkingForResolutionList(List<YangResolutionInfo> resolutionList,
- HasResolutionInfo resolutionInfoNode)
+ HasResolutionInfo resolutionInfoNode)
throws DataModelException {
+
for (YangResolutionInfo resolutionInfo : resolutionList) {
if (resolutionInfo.getPrefix() == null ||
resolutionInfo.getPrefix().equals(resolutionInfoNode.getPrefix())) {
diff --git a/src/main/java/org/onosproject/yangutils/datamodel/utils/GeneratedLanguage.java b/src/main/java/org/onosproject/yangutils/datamodel/utils/GeneratedLanguage.java
index 96fcbc0..e2471cd 100644
--- a/src/main/java/org/onosproject/yangutils/datamodel/utils/GeneratedLanguage.java
+++ b/src/main/java/org/onosproject/yangutils/datamodel/utils/GeneratedLanguage.java
@@ -16,7 +16,7 @@
package org.onosproject.yangutils.datamodel.utils;
/**
- * The target language in which the YANG information is modeled.
+ * Represents the target language in which the YANG information is modeled.
*/
public enum GeneratedLanguage {
/**
diff --git a/src/main/java/org/onosproject/yangutils/datamodel/utils/YangDataModelFactory.java b/src/main/java/org/onosproject/yangutils/datamodel/utils/YangDataModelFactory.java
index 2f24bf3..6edd6a6 100644
--- a/src/main/java/org/onosproject/yangutils/datamodel/utils/YangDataModelFactory.java
+++ b/src/main/java/org/onosproject/yangutils/datamodel/utils/YangDataModelFactory.java
@@ -46,12 +46,12 @@
import org.onosproject.yangutils.translator.exception.TranslatorException;
/**
- * Factory to create data model objects based on the target file type.
+ *Represents factory to create data model objects based on the target file type.
*/
public final class YangDataModelFactory {
/**
- * Utility class, hence private to prevent creating objects.
+ * Creates a YANG data model factory object.
*/
private YangDataModelFactory() {
}
@@ -75,7 +75,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -93,7 +93,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -111,7 +111,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -129,7 +129,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -147,7 +147,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -165,7 +165,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -183,7 +183,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -201,7 +201,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -219,7 +219,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -237,7 +237,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -255,7 +255,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -273,7 +273,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated
@@ -291,7 +291,7 @@
}
/**
- * Based on the target language generate the inherited data model node.
+ * Returns based on the target language generate the inherited data model node.
*
* @param targetLanguage target language in which YANG mapping needs to be
* generated