org.sdmlib.doc.util

Class JavaDocValidator

java.lang.Object

org.sdmlib.doc.util.JavaDocValidator

public class JavaDocValidator
extends java.lang.Object

This class can check a part of file tree which contains java files. The java doc is the object to validate. The validator checks if there is a java doc and it is correct.

Constructor Summary

Constructors

Constructor and Description
JavaDocValidator()

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	validateFileTree(java.io.File start, boolean printOnConsole, boolean fullCheck) This methods goes recursively through a file tree, starting by the given file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaDocValidator

public JavaDocValidator()

Method Detail

validateFileTree

public java.util.ArrayList<java.lang.String> validateFileTree(java.io.File start,
                                                              boolean printOnConsole,
                                                              boolean fullCheck)

This methods goes recursively through a file tree, starting by the given file. Only files like *.java and directories will visit, java files will validated. If there is no java doc for a method or the java doc is not valid, there will be created a trace information. This will be saved in a list and returned by this method. If the boolean printOnConsole is set to true, a founded trace information will be printed in the console.

Parameters:

start - The start of the file tree

printOnConsole - Should founded warnings or error printed on the console

fullCheck - If true everything will checked in every class, if false only created java doc will validate.

Returns:

A list with all trace informations