com.manoelcampos.javadoc.coverage.stats

Class MethodTagsDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.MethodTagsDocStats

All Implemented Interfaces:

DocStats

Direct Known Subclasses:

MethodExceptionsDocStats, MethodParamsDocStats

public abstract class MethodTagsDocStats
extends MembersDocStats

An abstract class to compute JavaDoc statistics for a set of tags associated to a method/constructor, such as the @param and @throws tags. Each MethodTagsDocStats sub-class is accountable to compute statistics to a specific kind of tag such as method's parameters or thrown exceptions.

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.
abstract String	getTagName() The name of the tags associated to this object for which JavaDoc coverage statistics will be computed, for instance, "param" or "throws" tags.
boolean	hasDocumentation() Checks if the the owner of the members has a documentation itself.

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, getMembersNumber, getType, getUndocumentedMembers

Method Detail

getTagName

public abstract String getTagName()

The name of the tags associated to this object for which JavaDoc coverage statistics will be computed, for instance, "param" or "throws" tags.

Returns:

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

hasDocumentation

public boolean hasDocumentation()

Description copied from class: MembersDocStats

Checks if the the owner of the members has a documentation itself.

Specified by:

hasDocumentation in class MembersDocStats

Returns:

true if the owner has documentation, false otherwise