Index (JavaDoc Coverage Maven Plugin 1.1.0 API)

A B C D E F G H I J L M O P S U V

A

AbstractDataExporter - Class in com.manoelcampos.javadoc.coverage.exporter: Abstract class to implement JavaDoc Coverage reports in different formats.
AbstractDataExporter(CoverageDoclet, String) - Constructor for class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter: Instantiates a DataExporter object to generate JavaDoc coverage report.
AbstractDataExporter(CoverageDoclet) - Constructor for class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter: Instantiates a DataExporter object that generates JavaDoc coverage report to the standard output.
addPackageDoc(PackageDoc) - Method in class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats: Adds an element to the Set of elements containing packages' JavaDocs.
afterBuild() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
afterBuild() - Method in class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
afterBuild() - Method in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter
average(DoubleStream) - Static method in class com.manoelcampos.javadoc.coverage.Utils: Computes the mean value from a Stream of values.

B

boolToInt(boolean) - Static method in class com.manoelcampos.javadoc.coverage.Utils: Converts a boolean to its corresponding int
build() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
build() - Method in interface com.manoelcampos.javadoc.coverage.exporter.DataExporter: Builds the JavaDoc Coverage Report to the file specified by DataExporter.getReportFileName().

C

ClassDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes statistics about the JavaDocs of a class, inner class, interface or enum and its members, such as: fields, methods, constructors and annotations.
ClassDocStats(ClassDoc) - Constructor for class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
ClassesDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc coverage statistics for a list of classes.
ClassesDocStats(ClassDoc[]) - Constructor for class com.manoelcampos.javadoc.coverage.stats.ClassesDocStats: Instantiates an object to compute JavaDoc coverage statistics for a list of classes.
ClassMembersDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc coverage statistics for specific type of members belonging to an owner.
COLUMNS - Static variable in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter
com.manoelcampos.javadoc.coverage - package com.manoelcampos.javadoc.coverage
com.manoelcampos.javadoc.coverage.exporter - package com.manoelcampos.javadoc.coverage.exporter
com.manoelcampos.javadoc.coverage.stats - package com.manoelcampos.javadoc.coverage.stats: Contains DocStats classes used to compute JavaDoc coverage statistics for Java elements such as classes, interfaces, fields, methods, parameters, etc.
computePercentage(double, double) - Static method in class com.manoelcampos.javadoc.coverage.Utils: Computes the percentage that a partial value corresponds to a given total.
ConsoleExporter - Class in com.manoelcampos.javadoc.coverage.exporter: Prints the JavaDoc coverage report to the console (standard output).
ConsoleExporter(CoverageDoclet) - Constructor for class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
CoverageDoclet - Class in com.manoelcampos.javadoc.coverage: A Doclet that computes coverage of JavaDoc documentation.
CoverageDoclet(RootDoc) - Constructor for class com.manoelcampos.javadoc.coverage.CoverageDoclet: Instantiate the Doclet which will parse the JavaDocs and generate the coverage report.

D

DataExporter - Interface in com.manoelcampos.javadoc.coverage.exporter: An interface to implement JavaDoc Coverage reports in different formats such as HTML, CSV, JSON, etc.
DEFAULT_OUTPUT_NAME - Static variable in interface com.manoelcampos.javadoc.coverage.exporter.DataExporter: The name to be used as default for the JavaDoc Coverage report if a specific name is not given.
disablePrintIfNoMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.MembersDocStats: Disables printing JavaDoc coverage statistics if the owner has no member.
DocStats - Interface in com.manoelcampos.javadoc.coverage.stats: An interface to be implemented by classes computing JavaDoc coverage statistics.

E

enablePrintIfNoMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.MembersDocStats: Enables printing JavaDoc coverage statistics even if the owner has no member.
exportClassesDocStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
exportClassesDocStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
exportClassesDocStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter
exportPackagesDocStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
exportPackagesDocStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
exportPackagesDocStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter
exportProjectDocumentationCoverageSummary() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
exportProjectDocumentationCoverageSummary() - Method in class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
exportProjectDocumentationCoverageSummary() - Method in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter

F

footer() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
footer() - Method in class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
footer() - Method in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter

G

getAnnotationsStats() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getClassesDocStats() - Method in class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats: Gets the object containing JavaDoc coverage statistics for detected classes.
getClassesList() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassesDocStats: Gets a List where each element represents the individual JavaDoc coverage statistics for a specific class.
getConstructorsStats() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getDoc() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassesDocStats
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassMembersDocStats
getDocumentedMembers() - Method in interface com.manoelcampos.javadoc.coverage.stats.DocStats: Gets the number of documented members contained into the object for which the JavaDoc coverage statistics is being computed.
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodTagsDocStats
getDocumentedMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats
getDocumentedMembersPercent() - Method in interface com.manoelcampos.javadoc.coverage.stats.DocStats: Gets the percentage of documented members contained into the object for which the JavaDoc coverage statistics is being computed.
getDocumentedMembersPercent() - Method in class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats
getDocumentedMembersPercent() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats
getEnumsStats() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getFieldsStats() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getFile() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
getFileExtension(String) - Static method in class com.manoelcampos.javadoc.coverage.Utils: Gets the extension of a file.
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassesDocStats
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassMembersDocStats: Gets the number of members which are explicitly declared into the source code, from a list of given members.
getMembersNumber() - Method in interface com.manoelcampos.javadoc.coverage.stats.DocStats: Gets the total number of members contained into the object for which the JavaDoc coverage statistics is being computed.
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodExceptionsDocStats
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodParamsDocStats
getMembersNumber() - Method in class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats
getMethodName() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats
getMethodsStats() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getName() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getOptionValues(String[]) - Method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Gets the values associated to a given command line option.
getOutputFile(String) - Method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Gets a File object from a given file name.
getPackageName() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getPackagesDoc() - Method in class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats: Gets a Set of elements containing packages' JavaDocs.
getPackagesDocStats() - Method in class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats: Gets the object containing JavaDoc coverage statistics for detected packages.
getParamsStats() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats: Gets the JavaDoc coverage statistics for the method/constructor's parameters.
getReportFileName() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
getReportFileName() - Method in interface com.manoelcampos.javadoc.coverage.exporter.DataExporter: Gets the actual name to be used for the JavaDoc Coverage Report, whether the default or given one.
getRootDoc() - Method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Gets the root element which enables reading JavaDoc documentation from the Java files given to the JavaDoc tool.
getStats() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
getTagName() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodExceptionsDocStats
getTagName() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodParamsDocStats
getTagName() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodTagsDocStats: The name of the tags associated to this object for which JavaDoc coverage statistics will be computed, for instance, "param" or "throws" tags.
getThrownExceptions() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats: Gets the JavaDoc coverage statistics for the exceptions thrown by the method/constructor.
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassesDocStats
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassMembersDocStats
getType() - Method in interface com.manoelcampos.javadoc.coverage.stats.DocStats: The type of the element to which JavaDoc coverage statistics is being computed, whether a class, interface, field, method, parameter, etc.
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodExceptionsDocStats
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodParamsDocStats
getType() - Method in class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats
getUndocumentedMembers() - Method in interface com.manoelcampos.javadoc.coverage.stats.DocStats: Gets the number of undocumented members contained into the object for which the JavaDoc coverage statistics is being computed.
getWriter(File) - Method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Gets a PrintWriter used by the CoverageDoclet.exporter to write the coverage report to.
getWriter() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter

H

hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassDocStats
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassesDocStats: A set of classes doesn't have documentation, only each individual class may have.
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.ClassMembersDocStats: A set of class members doesn't have documentation, only each individual member may have.
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.MembersDocStats: Checks if the the owner of the members has a documentation itself.
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodParamsDocStats: A set of params doesn't have documentation, only each individual param may have.
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodTagsDocStats
hasDocumentation() - Method in class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats: A set of packages doesn't have documentation, only each individual package may have.
header() - Method in class com.manoelcampos.javadoc.coverage.exporter.AbstractDataExporter
header() - Method in class com.manoelcampos.javadoc.coverage.exporter.ConsoleExporter
header() - Method in class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter
HtmlExporter - Class in com.manoelcampos.javadoc.coverage.exporter: Exports the JavaDoc coverage report to an HTML file.
HtmlExporter(CoverageDoclet) - Constructor for class com.manoelcampos.javadoc.coverage.exporter.HtmlExporter

I

includeTrailingDirSeparator(String) - Static method in class com.manoelcampos.javadoc.coverage.Utils: Adds a trailing slash at the end of a path if it doesn't have one yet.
isNotStringEmpty(String) - Static method in class com.manoelcampos.javadoc.coverage.Utils
isPrintIfNoMembers() - Method in class com.manoelcampos.javadoc.coverage.stats.MembersDocStats: Checks if JavaDoc coverage statistics should be printed if the owner has no member.
isReturnValueDocumented() - Method in class com.manoelcampos.javadoc.coverage.stats.MethodDocStats: Checks if the return value of the method/constructor is documented or not.
isStringEmpty(String) - Static method in class com.manoelcampos.javadoc.coverage.Utils

J

JavaDocsStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc coverage statistics for Java files received by the JavaDoc tool.
JavaDocsStats(RootDoc) - Constructor for class com.manoelcampos.javadoc.coverage.stats.JavaDocsStats: Instantiates an object to compute JavaDoc coverage statistics for all Java files received by the JavaDoc tool.

L

languageVersion() - Static method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Gets the version of the Java Programming Language supported by this doclet.

M

mean(double...) - Static method in class com.manoelcampos.javadoc.coverage.Utils: Computes the mean value from a list of values.
MembersDocStats - Class in com.manoelcampos.javadoc.coverage.stats: An abstract class to compute JavaDocs coverage statistics for a list of members belonging to another object, which is called the owner.
MembersDocStats() - Constructor for class com.manoelcampos.javadoc.coverage.stats.MembersDocStats
MethodDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc coverage statistics for a method/constructor and its members, such as: parameters and thrown exceptions.
MethodExceptionsDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc coverage statistics for the exceptions thrown by a specific method.
MethodParamsDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc coverage statistics for parameters from a specific method.
MethodTagsDocStats - Class in com.manoelcampos.javadoc.coverage.stats: An abstract class to compute JavaDoc statistics for a set of tags associated to a method/constructor, such as the @param and @throws tags.

O

optionLength(String) - Static method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Gets the number of arguments that a given command line option must contain.
OUTPUT_NAME_OPTION - Static variable in class com.manoelcampos.javadoc.coverage.CoverageDoclet: A command line parameter to enable defining the name of the coverage report.

P

PackagesDocStats - Class in com.manoelcampos.javadoc.coverage.stats: Computes JavaDoc statistics for a set of packages.
PackagesDocStats() - Constructor for class com.manoelcampos.javadoc.coverage.stats.PackagesDocStats

S

start(RootDoc) - Static method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Starts the actual parsing or JavaDoc documentation and generation of the coverage report.

U

Utils - Class in com.manoelcampos.javadoc.coverage: A class providing some utility methods.

V

validOptions(String[][], DocErrorReporter) - Static method in class com.manoelcampos.javadoc.coverage.CoverageDoclet: Validates command line options.

A B C D E F G H I J L M O P S U V