com.manoelcampos.javadoc.coverage.stats

Class ClassMembersDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.ClassMembersDocStats

All Implemented Interfaces:

DocStats

public class ClassMembersDocStats
extends MembersDocStats

Computes JavaDoc coverage statistics for specific type of members belonging to an owner. An owner can be a class, interface or enum. Members may be either fields, methods or constructors.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Method Summary

Modifier and Type	Method and Description
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 number of members which are explicitly declared into the source code, from a list of given members.
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 class members doesn't have documentation, only each individual member 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

Method Detail

getMembersNumber

public long getMembersNumber()

Gets the number of members which are explicitly declared into the source code, from a list of given members. The length of the given array cannot be used to this purpose because some elements such as default no-args constructors are not directly declared into the source class but are counted as a member. This way, it may count as a non-documented element while it doesn't even exist into the source code.

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

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

hasDocumentation

public boolean hasDocumentation()

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

Specified by:

hasDocumentation in class MembersDocStats

Returns: