com.manoelcampos.javadoc.coverage.stats

Class MembersDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

All Implemented Interfaces:

DocStats

Direct Known Subclasses:

ClassDocStats, ClassesDocStats, ClassMembersDocStats, MethodDocStats, MethodTagsDocStats, PackagesDocStats

public abstract class MembersDocStats
extends Object
implements DocStats

An abstract class to compute JavaDocs coverage statistics for a list of members belonging to another object, which is called the owner.

In the case the owner of the members is:

• a class, this object computes statistics for its fields, methods and so on.
• a method, this object computes statistics for its parameters and thrown exceptions.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Constructor Summary

Constructors

Constructor and Description
MembersDocStats()

Method Summary

Modifier and Type	Method and Description
void	disablePrintIfNoMembers() Disables printing JavaDoc coverage statistics if the owner has no member.
void	enablePrintIfNoMembers() Enables printing JavaDoc coverage statistics even if the owner has no member.
abstract boolean	hasDocumentation() Checks if the the owner of the members has a documentation itself.
boolean	isPrintIfNoMembers() Checks if JavaDoc coverage statistics should be printed if the owner has no member.

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

getDocumentedMembers, getDocumentedMembersPercent, getMembersNumber, getType, getUndocumentedMembers

Constructor Detail

MembersDocStats

public MembersDocStats()

Method Detail

hasDocumentation

public abstract boolean hasDocumentation()

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

Returns:

true if the owner has documentation, false otherwise

isPrintIfNoMembers

public final boolean isPrintIfNoMembers()

Checks if JavaDoc coverage statistics should be printed if the owner has no member.

Returns:

true if statistics should be printed even if the owner has no member, false if statistics shouldn't be printed if the owner has no member

enablePrintIfNoMembers

public final void enablePrintIfNoMembers()

Enables printing JavaDoc coverage statistics even if the owner has no member.

disablePrintIfNoMembers

public final void disablePrintIfNoMembers()

Disables printing JavaDoc coverage statistics if the owner has no member.