Coding gudilines for class and methods javadocs fixed.
Change-Id: I0153e6391c9ec9eacaac65c3989834b6bf5c65bf
diff --git a/src/main/java/org/onosproject/yangutils/utils/io/impl/CopyrightHeader.java b/src/main/java/org/onosproject/yangutils/utils/io/impl/CopyrightHeader.java
index ff4a1ce..0a385ac 100644
--- a/src/main/java/org/onosproject/yangutils/utils/io/impl/CopyrightHeader.java
+++ b/src/main/java/org/onosproject/yangutils/utils/io/impl/CopyrightHeader.java
@@ -27,7 +27,7 @@
import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE;
/**
- * Provides the license header for the generated files.
+ * Represents the license header for the generated files.
*/
public final class CopyrightHeader {
@@ -39,7 +39,7 @@
private static String copyrightHeader;
/**
- * Default constructor.
+ * Creates an instance of copyright header.
*/
private CopyrightHeader() {
}
@@ -69,11 +69,11 @@
}
/**
- * parse Copyright to the temporary file.
+ * parses Copyright to the temporary file.
*
* @throws IOException when fails to get the copyright header
*/
- public static void parseCopyrightHeader() throws IOException {
+ private static void parseCopyrightHeader() throws IOException {
File temp = new File(TEMP_FILE);
diff --git a/src/main/java/org/onosproject/yangutils/utils/io/impl/FileSystemUtil.java b/src/main/java/org/onosproject/yangutils/utils/io/impl/FileSystemUtil.java
index 6955bb5..3765f71 100644
--- a/src/main/java/org/onosproject/yangutils/utils/io/impl/FileSystemUtil.java
+++ b/src/main/java/org/onosproject/yangutils/utils/io/impl/FileSystemUtil.java
@@ -36,18 +36,18 @@
import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.createDirectories;
/**
- * Utility to handle file system operations.
+ * Represents utility to handle file system operations.
*/
public final class FileSystemUtil {
/**
- * Hiding constructor of a utility class.
+ * Creates an instance of file system util.
*/
private FileSystemUtil() {
}
/**
- * Check if the package directory structure created.
+ * Checks if the package directory structure created.
*
* @param pkg Package to check if it is created
* @return existence status of package
@@ -63,7 +63,7 @@
}
/**
- * Create a package structure with package info java file if not present.
+ * Creates a package structure with package info java file if not present.
*
* @param pkg java package string
* @param pkgInfo description of package
@@ -82,7 +82,7 @@
}
/**
- * Read the contents from source file and append its contents to append
+ * Reads the contents from source file and append its contents to append
* file.
*
* @param toAppend destination file in which the contents of source file is
@@ -133,7 +133,7 @@
}
/**
- * Update the generated file handle.
+ * Updates the generated file handle.
*
* @param inputFile input file
* @param contentTobeAdded content to be appended to the file
diff --git a/src/main/java/org/onosproject/yangutils/utils/io/impl/JavaDocGen.java b/src/main/java/org/onosproject/yangutils/utils/io/impl/JavaDocGen.java
index 651873c..c25c947 100644
--- a/src/main/java/org/onosproject/yangutils/utils/io/impl/JavaDocGen.java
+++ b/src/main/java/org/onosproject/yangutils/utils/io/impl/JavaDocGen.java
@@ -49,12 +49,12 @@
import static org.onosproject.yangutils.utils.UtilConstants.VALUE;
/**
- * Provides javadoc for the generated classes.
+ * Represents javadoc for the generated classes.
*/
public final class JavaDocGen {
/**
- * Default Constructor.
+ * Creates an instance of java doc gen.
*/
private JavaDocGen() {
}
diff --git a/src/main/java/org/onosproject/yangutils/utils/io/impl/YangFileScanner.java b/src/main/java/org/onosproject/yangutils/utils/io/impl/YangFileScanner.java
index 412aefd..6da8bcd 100644
--- a/src/main/java/org/onosproject/yangutils/utils/io/impl/YangFileScanner.java
+++ b/src/main/java/org/onosproject/yangutils/utils/io/impl/YangFileScanner.java
@@ -23,7 +23,7 @@
import java.util.Stack;
/**
- * Provides utility for searching the files in a directory.
+ * Represents utility for searching the files in a directory.
*/
public final class YangFileScanner {
@@ -31,7 +31,7 @@
private static final String YANG_FILE_EXTENTION = ".yang";
/**
- * Default constructor.
+ * Creates an instance of YANG file scanner.
*/
private YangFileScanner() {
}
diff --git a/src/main/java/org/onosproject/yangutils/utils/io/impl/YangIoUtils.java b/src/main/java/org/onosproject/yangutils/utils/io/impl/YangIoUtils.java
index 78a3aef..c15d580 100644
--- a/src/main/java/org/onosproject/yangutils/utils/io/impl/YangIoUtils.java
+++ b/src/main/java/org/onosproject/yangutils/utils/io/impl/YangIoUtils.java
@@ -48,7 +48,7 @@
import static org.slf4j.LoggerFactory.getLogger;
/**
- * Provides common utility functionalities for code generation.
+ * Represents common utility functionalities for code generation.
*/
public final class YangIoUtils {
@@ -56,7 +56,7 @@
private static final String TARGET_RESOURCE_PATH = SLASH + TEMP + SLASH + YANG_RESOURCES + SLASH;
/**
- * Default constructor.
+ * Creates an instance of YANG io utils.
*/
private YangIoUtils() {
}
@@ -68,7 +68,6 @@
* @return directory structure
*/
public static File createDirectories(String path) {
-
File generatedDir = new File(path);
generatedDir.mkdirs();
return generatedDir;
@@ -114,7 +113,6 @@
* @throws IOException when failed to delete directory
*/
public static void clean(String dir) throws IOException {
-
File generatedDirectory = new File(dir);
if (generatedDirectory.exists()) {
try {
@@ -133,7 +131,6 @@
* @param context current build context
*/
public static void addToSource(String source, MavenProject project, BuildContext context) {
-
project.addCompileSourceRoot(source);
context.refresh(project.getBasedir());
log.info("Source directory added to compilation root: " + source);
@@ -147,7 +144,6 @@
* @return new string
*/
public static String trimAtLast(String valueString, String removealStirng) {
-
StringBuilder stringBuilder = new StringBuilder(valueString);
int index = valueString.lastIndexOf(removealStirng);
stringBuilder.deleteCharAt(index);
@@ -161,7 +157,6 @@
* @return parted string
*/
public static String partString(String partString) {
-
String[] strArray = partString.split(COMMA);
String newString = EMPTY_STRING;
for (int i = 0; i < strArray.length; i++) {
@@ -176,7 +171,7 @@
}
/**
- * Get the directory path of the package in canonical form.
+ * Returns the directory path of the package in canonical form.
*
* @param baseCodeGenPath base path where the generated files needs to be
* put
@@ -197,7 +192,7 @@
}
/**
- * Get the absolute path of the package in canonical form.
+ * Returns the absolute path of the package in canonical form.
*
* @param baseCodeGenPath base path where the generated files needs to be
* put
@@ -205,12 +200,11 @@
* @return absolute path of the package in canonical form
*/
public static String getAbsolutePackagePath(String baseCodeGenPath, String pathOfJavaPkg) {
-
return baseCodeGenPath + pathOfJavaPkg;
}
/**
- * Copy YANG files to the current project's output directory.
+ * Copies YANG files to the current project's output directory.
*
* @param yangFiles list of YANG files
* @param outputDir project's output directory
@@ -243,7 +237,6 @@
* @return list of files
*/
private static List<File> getListOfFile(List<String> strings) {
-
List<File> files = new ArrayList<>();
for (String file : strings) {
files.add(new File(file));
@@ -252,14 +245,13 @@
}
/**
- * Merge the temp java files to main java files.
+ * Merges the temp java files to main java files.
*
* @param appendFile temp file
* @param srcFile main file
* @throws IOException when fails to append contents
*/
public static void mergeJavaFiles(File appendFile, File srcFile) throws IOException {
-
try {
appendFileContents(appendFile, srcFile);
} catch (IOException e) {
@@ -268,14 +260,13 @@
}
/**
- * Insert data in the generated file.
+ * Inserts data in the generated file.
*
* @param file file in which need to be inserted
* @param data data which need to be inserted
* @throws IOException when fails to insert into file
*/
public static void insertDataIntoJavaFile(File file, String data) throws IOException {
-
try {
updateFileHandle(file, data, false);
} catch (IOException e) {