|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.javadoc.Doclet | +--de.kosi.utiltest.KosiDoclet
Doclet that checks that there is information available for every package, class, interface and member. (modified, to log Warnings to a logfile)
Field Summary | |
static java.lang.String |
LOGFILE
Datei in der die Warnungen Protokolliert werden. |
Constructor Summary | |
KosiDoclet()
Von dieser Klasse sollten keine Instanzen erzeugt werden, da sie nur statische Methoden enthält. |
Method Summary | |
protected static void |
checkClasses(com.sun.javadoc.ClassDoc[] classes)
Checks all aspects of the documentation of the specified classes. |
protected static void |
checkClassImpl()
Checks classes. |
protected static void |
checkConstructor()
Checks all aspects of the documentation of the constructor. |
protected static void |
checkConstructorImpl()
Checks Constructors. |
protected static void |
checkConstructorReturnImpl()
Empty Method. |
protected static void |
checkExceptions()
Checks the exceptions of a Method. |
protected static void |
checkExceptionsImpl()
Checks method exceptions. |
protected static void |
checkExecutableMembers(com.sun.javadoc.ExecutableMemberDoc[] members)
Checks all aspects of the documentation of the specified executable members. |
protected static void |
checkFieldImpl()
Checks fields. |
protected static void |
checkFields(com.sun.javadoc.FieldDoc[] fields)
Checks all aspects of the documentation of the specified fields. |
protected static void |
checkMethod()
Checks a Method. |
protected static void |
checkMethodImpl()
Checks methods. |
protected static void |
checkMethodReturnImpl()
Checks method return value. |
protected static void |
checkPackageImpl()
Checks a package. |
protected static void |
checkPackages(com.sun.javadoc.PackageDoc[] packages)
Checks all aspects of the documentation of the specified packages. |
protected static void |
checkParameters()
Checks the parameters of a Method. |
protected static void |
checkParametersImpl()
Checks method parameters. |
protected static void |
checkReturn()
Checks the return value of a Method. |
protected static void |
foundCommentsForNonExistentException(java.lang.String name)
Handler for the cognition that there are comments for a non-existing exception. |
protected static void |
foundCommentsForNonExistentParameter(java.lang.String name)
Handler for the cognition that there are comments for a non-existing parameter. |
protected static void |
foundCommentsForNonExistentReturnValue(int count)
Handler for the cognition that there are comments for a non-existing return value. |
protected static boolean |
isEmptyString(java.lang.String s)
Returns if a string is empty. |
protected static void |
missingClassComments()
Handler for the condition that a class has no associated comments. |
protected static void |
missingCommentsForException(java.lang.String name)
Handler for the cognition that there are no comments for a exception. |
protected static void |
missingCommentsForReturnValue()
Handler for the cognition that there is no comment for a return value. |
protected static void |
missingConstructorComments()
Hanlder for the conition that an executable member (constructor, class function or instance method) has no associated comments. |
protected static void |
missingFieldComments()
Handler for the cognition that there are no comments for a field. |
protected static void |
missingMethodComments()
Hanlder for the conition that an executable member (constructor, class function or instance method) has no associated comments. |
protected static void |
missingPackageComments()
Handler for the condition that a package has no associated comments. |
protected static void |
missingParameterComments(java.lang.String name)
Handler for the cognition that the parameter for an executable member (constructor, class function or instance method) has no associated comments. |
protected static void |
multipleCommentsForParameter(java.lang.String name,
int count)
Handler for the cognition that there are multiple comments for a executable member- |
protected static void |
multipleCommentsForReturnValue(int count)
Handler for the cognition that there are multiple comments for a return value. |
static boolean |
start(com.sun.javadoc.RootDoc rootDoc)
Run this doclet for the specified packages or classes. |
Methods inherited from class com.sun.javadoc.Doclet |
optionLength, validOptions |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String LOGFILE
Constructor Detail |
public KosiDoclet()
Method Detail |
public static boolean start(com.sun.javadoc.RootDoc rootDoc)
rootDoc
- The information for this run of javadoc.true
, on failure: false
.protected static final void checkPackages(com.sun.javadoc.PackageDoc[] packages)
packageDoc
and
packageName
checkPackageImpl()
checkClasses(ClassDoc[])
If the argument is null
, then no packages or classes are
checked.
At the end, both packageDoc
and
packageName
are set to null
.
Note: This method does not handle duplicate elements gracefully.
packages
- The packages to be checked. There should be no
null elements, and no duplicate elements.protected static final void checkClasses(com.sun.javadoc.ClassDoc[] classes)
classes
- Classes to be checked.protected static final void checkFields(com.sun.javadoc.FieldDoc[] fields)
fields
- Fields to be checked.protected static final void checkExecutableMembers(com.sun.javadoc.ExecutableMemberDoc[] members)
members
- executable members to be checked.protected static final void checkConstructor()
protected static final void checkMethod()
protected static final void checkParameters()
protected static final void checkReturn()
protected static final void checkExceptions()
protected static void checkPackageImpl()
protected static final void checkClassImpl()
protected static void checkFieldImpl()
protected static void checkConstructorImpl()
protected static void checkMethodImpl()
protected static void checkParametersImpl()
protected static void checkMethodReturnImpl()
protected static void checkConstructorReturnImpl()
protected static void checkExceptionsImpl()
protected static void missingPackageComments()
protected static void missingClassComments()
protected static void missingMethodComments()
protected static void missingConstructorComments()
protected static void missingParameterComments(java.lang.String name)
name
- Name of the missing parameter.protected static void multipleCommentsForParameter(java.lang.String name, int count)
name
- Name of the missing parameter.count
- the number of the comments.protected static void foundCommentsForNonExistentParameter(java.lang.String name)
name
- Name of the parameter.protected static void missingCommentsForReturnValue()
protected static void multipleCommentsForReturnValue(int count)
count
- number of the comments.protected static void foundCommentsForNonExistentReturnValue(int count)
count
- number of the comments.protected static void missingCommentsForException(java.lang.String name)
name
- Name of the Exception.protected static void foundCommentsForNonExistentException(java.lang.String name)
name
- Name of the Exception.protected static void missingFieldComments()
protected static final boolean isEmptyString(java.lang.String s)
s
- String to be tested.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |