com.manoelcampos.javadoc.coverage.stats

Class PackagesDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.PackagesDocStats

All Implemented Interfaces:

DocStats

public class PackagesDocStats
extends MembersDocStats

Computes JavaDoc statistics for a set of packages.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Constructor Summary

Constructors

Constructor and Description
PackagesDocStats()

Method Summary

Modifier and Type	Method and Description
void	addPackageDoc(com.sun.javadoc.PackageDoc doc) Adds an element to the Set of elements containing packages' JavaDocs.
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.
Set<com.sun.javadoc.PackageDoc>	getPackagesDoc() Gets a Set of elements containing packages' JavaDocs.
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 packages doesn't have documentation, only each individual package 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

PackagesDocStats

public PackagesDocStats()

Method Detail

addPackageDoc

public void addPackageDoc(com.sun.javadoc.PackageDoc doc)

Adds an element to the Set of elements containing packages' JavaDocs.

Parameters:

doc - the package's JavaDoc element to add to the Set

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

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

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

getPackagesDoc

public Set<com.sun.javadoc.PackageDoc> getPackagesDoc()

Gets a Set of elements containing packages' JavaDocs.

Returns:

the Set of packages' JavaDocs

hasDocumentation

public boolean hasDocumentation()

A set of packages doesn't have documentation, only each individual package may have.

Specified by:

hasDocumentation in class MembersDocStats

Returns: