com.manoelcampos.javadoc.coverage.stats

Class JavaDocsStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.JavaDocsStats

All Implemented Interfaces:

DocStats

public class JavaDocsStats
extends Object
implements DocStats

Computes JavaDoc coverage statistics for Java files received by the JavaDoc tool.

It's the main class to store JavaDocs statistics for any kind of documentable element into a Java source file. It includes the computed statistics for an entire Java project parsed by the JavaDoc Tool.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Constructor Summary

Constructors

Constructor and Description
JavaDocsStats(com.sun.javadoc.RootDoc rootDoc) Instantiates an object to compute JavaDoc coverage statistics for all Java files received by the JavaDoc tool.

Method Summary

Modifier and Type	Method and Description
ClassesDocStats	getClassesDocStats() Gets the object containing JavaDoc coverage statistics for detected classes.
long	getDocumentedMembers() Gets the number of documented members contained into the object for which the JavaDoc coverage statistics is being computed.
double	getDocumentedMembersPercent() Gets the percentage of documented members contained into the object for which the JavaDoc coverage statistics is being computed.
long	getMembersNumber() Gets the total number of members contained into the object for which the JavaDoc coverage statistics is being computed.
PackagesDocStats	getPackagesDocStats() Gets the object containing JavaDoc coverage statistics for detected packages.
String	getType() The type of the element to which JavaDoc coverage statistics is being computed, whether a class, interface, field, method, parameter, etc.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.manoelcampos.javadoc.coverage.stats.DocStats

getUndocumentedMembers

Constructor Detail

JavaDocsStats

public JavaDocsStats(com.sun.javadoc.RootDoc rootDoc)

Instantiates an object to compute JavaDoc coverage statistics for all Java files received by the JavaDoc tool.

Parameters:

rootDoc - root element which enables reading JavaDoc documentation

Method Detail

getPackagesDocStats

public PackagesDocStats getPackagesDocStats()

Gets the object containing JavaDoc coverage statistics for detected packages.

Returns:

packages' JavaDoc coverage statistics

See Also:

computePackagesDocsStats()

getClassesDocStats

public ClassesDocStats getClassesDocStats()

Gets the object containing JavaDoc coverage statistics for detected classes.

Returns:

classes' JavaDoc coverage statistics

getType

public String getType()

Description copied from interface: DocStats

The type of the element to which JavaDoc coverage statistics is being computed, whether a class, interface, field, method, parameter, etc.

Specified by:

getType in interface DocStats

Returns:

the type of elements

getDocumentedMembers

public long getDocumentedMembers()

Description copied from interface: DocStats

Gets the number of documented members contained into the object for which the JavaDoc coverage statistics is being computed.

Specified by:

getDocumentedMembers in interface DocStats

Returns:

the number of members having JavaDoc documentation

getDocumentedMembersPercent

public double getDocumentedMembersPercent()

Description copied from interface: DocStats

Gets the percentage of documented members contained into the object for which the JavaDoc coverage statistics is being computed.

Specified by:

getDocumentedMembersPercent in interface DocStats

Returns:

the percentage of documented members, in scale from 0 to 100.

getMembersNumber

public long getMembersNumber()

Description copied from interface: DocStats

Gets the total number of members contained into the object for which the JavaDoc coverage statistics is being computed.

Specified by:

getMembersNumber in interface DocStats

Returns:

the total number of members