com.jollem.doclint
Class DocLint
java.lang.Object
|
+--com.sun.javadoc.Doclet
|
+--com.jollem.doclint.DocLint
- public class DocLint
- extends com.sun.javadoc.Doclet
Doclet that checks that there is information available for every package,
class, interface and member.
- Version:
- $Revision: 1.1 $
- Author:
- Ernst de Haan
(ernst@jollem.com)
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 |
_rootDoc
protected static com.sun.javadoc.RootDoc _rootDoc
_packageDoc
protected static com.sun.javadoc.PackageDoc _packageDoc
_packageName
protected static String _packageName
_classDoc
protected static com.sun.javadoc.ClassDoc _classDoc
_className
protected static String _className
_executableMemberDoc
protected static com.sun.javadoc.ExecutableMemberDoc _executableMemberDoc
_executableMemberName
protected static String _executableMemberName
_executableMemberSignature
protected static String _executableMemberSignature
_fieldDoc
protected static com.sun.javadoc.FieldDoc _fieldDoc
_fieldName
protected static String _fieldName
DocLint
public DocLint()
start
public static boolean start(com.sun.javadoc.RootDoc rootDoc)
- Run this doclet for the specified packages or classes.
- Parameters:
rootDoc
- The information for this run of javadoc.- Returns:
- On success,
true
, on failure: false
.
checkPackages
protected static void checkPackages(com.sun.javadoc.PackageDoc[] packages)
checkClasses
protected static void checkClasses(com.sun.javadoc.ClassDoc[] classes)
checkFields
protected static void checkFields(com.sun.javadoc.FieldDoc[] fields)
checkField
protected static final void checkField()
checkStaticField
protected static void checkStaticField()
checkInstanceField
protected static void checkInstanceField()
checkExecutableMembers
protected static void checkExecutableMembers(com.sun.javadoc.ExecutableMemberDoc[] members)
checkParameters
protected static void checkParameters()
checkReturn
protected static void checkReturn()
checkExceptions
protected static void checkExceptions()
missingPackageComment
protected static void missingPackageComment()
missingClassComment
protected static void missingClassComment()
missingExecutableMemberComment
protected static void missingExecutableMemberComment()
isEmptyString
protected static final boolean isEmptyString(String s)
Copyright © 2000 Jollem, Netherlands, All Rights Reserved.