com.manoelcampos.javadoc.coverage.stats

Class ClassesDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.ClassesDocStats

All Implemented Interfaces:

DocStats

public class ClassesDocStats
extends MembersDocStats

Computes JavaDoc coverage statistics for a list of classes.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Constructor Summary

Constructors

Constructor and Description
ClassesDocStats(com.sun.javadoc.ClassDoc[] docs) Instantiates an object to compute JavaDoc coverage statistics for a list of classes.

Method Summary

Modifier and Type	Method and Description
List<ClassDocStats>	getClassesList() Gets a List where each element represents the individual JavaDoc coverage statistics for a specific class.
long	getDocumentedMembers() Gets the number 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.
String	getType() The type of the element to which JavaDoc coverage statistics is being computed, whether a class, interface, field, method, parameter, etc.
boolean	hasDocumentation() A set of classes doesn't have documentation, only each individual class may have.

Methods inherited from class com.manoelcampos.javadoc.coverage.stats.MembersDocStats

disablePrintIfNoMembers, enablePrintIfNoMembers, isPrintIfNoMembers

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

getDocumentedMembersPercent, getUndocumentedMembers

Constructor Detail

ClassesDocStats

public ClassesDocStats(com.sun.javadoc.ClassDoc[] docs)

Instantiates an object to compute JavaDoc coverage statistics for a list of classes.

Parameters:

docs - an array of elements which enables reading the classes' JavaDoc documentation

Method Detail

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.

Returns:

the total number of members

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.

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.

Returns:

the number of members having JavaDoc documentation

getClassesList

public List<ClassDocStats> getClassesList()

Gets a List where each element represents the individual JavaDoc coverage statistics for a specific class.

Returns:

a List of class's JavaDoc coverage statistics

hasDocumentation

public boolean hasDocumentation()

A set of classes doesn't have documentation, only each individual class may have.

Specified by:

hasDocumentation in class MembersDocStats

Returns: