com.manoelcampos.javadoc.coverage.stats

Interface DocStats

All Known Implementing Classes:

ClassDocStats, ClassesDocStats, ClassMembersDocStats, JavaDocsStats, MembersDocStats, MethodDocStats, MethodExceptionsDocStats, MethodParamsDocStats, MethodTagsDocStats, PackagesDocStats

public interface DocStats

An interface to be implemented by classes computing JavaDoc coverage statistics.

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.
default double	getDocumentedMembersPercent() Gets the percentage 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.
default long	getUndocumentedMembers() Gets the number of undocumented members contained into the object for which the JavaDoc coverage statistics is being computed.

Method Detail

getType

String getType()

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

long getDocumentedMembers()

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

getUndocumentedMembers

default long getUndocumentedMembers()

Gets the number of undocumented members contained into the object for which the JavaDoc coverage statistics is being computed.

Returns:

the number of members not having JavaDoc documentation

getDocumentedMembersPercent

default double getDocumentedMembersPercent()

Gets the percentage of documented members contained into the object for which the JavaDoc coverage statistics is being computed.

Returns:

the percentage of documented members, in scale from 0 to 100.

getMembersNumber

long getMembersNumber()

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