com.manoelcampos.javadoc.coverage.stats

Class MethodDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.MethodDocStats

All Implemented Interfaces:

DocStats

public class MethodDocStats
extends MembersDocStats

Computes JavaDoc coverage statistics for a method/constructor and its members, such as: parameters and 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.
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	getMethodName()
MethodParamsDocStats	getParamsStats() Gets the JavaDoc coverage statistics for the method/constructor's parameters.
MethodExceptionsDocStats	getThrownExceptions() Gets the JavaDoc coverage statistics for the exceptions thrown by the method/constructor.
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() Checks if the the owner of the members has a documentation itself.
boolean	isReturnValueDocumented() Checks if the return value of the method/constructor is documented or not.

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

getUndocumentedMembers

Method Detail

isReturnValueDocumented

public boolean isReturnValueDocumented()

Checks if the return value of the method/constructor is documented or not.

Returns:

true if the return value is documented, false otherwise.

getMethodName

public String getMethodName()

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

getParamsStats

public MethodParamsDocStats getParamsStats()

Gets the JavaDoc coverage statistics for the method/constructor's parameters.

Returns:

getThrownExceptions

public MethodExceptionsDocStats getThrownExceptions()

Gets the JavaDoc coverage statistics for the exceptions thrown by the method/constructor.

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

getDocumentedMembersPercent

public double getDocumentedMembersPercent()

Description copied from interface: DocStats

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

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

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