From 0a0fbcb01497d4a860cbbcb60ecefdcee4f89067 Mon Sep 17 00:00:00 2001
From: Svjatoslav Agejenko <svjatoslav@svjatoslav.eu>
Date: Thu, 21 May 2015 22:51:08 +0300
Subject: [PATCH] fixed javadoc issues

---
 .../java/structure/ClassDescriptor.java          |  9 +++++++++
 .../inspector/java/structure/ClassGraph.java     | 16 ++++++++--------
 .../inspector/java/structure/Utils.java          |  4 ++++
 3 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassDescriptor.java b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassDescriptor.java
index 9f657d1..2494966 100755
--- a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassDescriptor.java
+++ b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassDescriptor.java
@@ -317,6 +317,10 @@ public class ClassDescriptor implements GraphElement {
 	/**
 	 * Returns field with given name (case is ignored). Or <code>null</code> if
 	 * field is not found.
+	 *
+	 * @param fieldToSearch
+	 *            field name (case is ignored)
+	 * @return field matching given name
 	 */
 	protected FieldDescriptor getFieldIgnoreCase(final String fieldToSearch) {
 
@@ -416,6 +420,11 @@ public class ClassDescriptor implements GraphElement {
 	/**
 	 * Checks if class has field with given name (case is ignored). Returns
 	 * <code>true</code> if such field is found.
+	 *
+	 * @param fieldToSearch
+	 *            field to search for (case is ignored)
+	 *
+	 * @return <code>true</code> if field is found.
 	 */
 	protected boolean hasFieldIgnoreCase(final String fieldToSearch) {
 
diff --git a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java
index 62e0911..c8de18b 100755
--- a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java
+++ b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java
@@ -44,6 +44,8 @@ public class ClassGraph {
 	/**
 	 * @param objects
 	 *            objects that shall be added to graph
+	 *
+	 * @return this {@link ClassGraph}
 	 */
 	public ClassGraph add(final Object... objects) {
 
@@ -84,17 +86,11 @@ public class ClassGraph {
 	}
 
 	/**
-	 * @param targetDirectory
-	 *            target directory name
-	 *
 	 * @param resultFileName
 	 *            file name for the generated graph. File extension will be
 	 *            added automatically. Existing file with the same name will be
 	 *            overwritten.
 	 *
-	 * @param keepDotFile
-	 *            if set to <code>true</code> then intermediary GraphViz DOT
-	 *            file will be kept.
 	 */
 
 	public void generateGraph(final String resultFileName) {
@@ -113,8 +109,8 @@ public class ClassGraph {
 			// execute GraphViz to visualize graph
 			try {
 				Runtime.getRuntime()
-				.exec(new String[] { "dot", "-Tpng", dotFilePath, "-o",
-						imageFilePath }).waitFor();
+						.exec(new String[] { "dot", "-Tpng", dotFilePath, "-o",
+								imageFilePath }).waitFor();
 			} catch (final InterruptedException e) {
 			} finally {
 			}
@@ -147,6 +143,8 @@ public class ClassGraph {
 	/**
 	 * @param clazz
 	 *            class that shall be added to graph
+	 *
+	 * @return {@link ClassDescriptor} corresponding to given {@link Class}
 	 */
 	protected ClassDescriptor getOrCreateClassDescriptor(final Class clazz) {
 
@@ -171,6 +169,8 @@ public class ClassGraph {
 
 	/**
 	 * Hide orphaned class that have no references
+	 *
+	 * @return this {@link ClassGraph}
 	 */
 	public ClassGraph hideOrphanedClasses() {
 
diff --git a/src/main/java/eu/svjatoslav/inspector/java/structure/Utils.java b/src/main/java/eu/svjatoslav/inspector/java/structure/Utils.java
index de74c13..6f599ef 100755
--- a/src/main/java/eu/svjatoslav/inspector/java/structure/Utils.java
+++ b/src/main/java/eu/svjatoslav/inspector/java/structure/Utils.java
@@ -16,6 +16,8 @@ public class Utils {
 
 	/**
 	 * retrieves colors from predefined palette
+	 *
+	 * @return next available dark color name
 	 */
 	protected static String getNextDarkColor() {
 		lastChosenDarkColor++;
@@ -27,6 +29,8 @@ public class Utils {
 
 	/**
 	 * retrieves colors from predefined palette
+	 *
+	 * @return next available light color name
 	 */
 	protected static String getNextLightColor() {
 		lastChosenLightColor++;
-- 
2.20.1