com.manoelcampos.javadoc.coverage.stats

Class MethodParamsDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.MethodTagsDocStats

com.manoelcampos.javadoc.coverage.stats.MethodParamsDocStats

All Implemented Interfaces:

DocStats

public class MethodParamsDocStats
extends MethodTagsDocStats

Computes JavaDoc coverage statistics for parameters from a specific method.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Method Summary

Modifier and Type	Method and Description
long	getMembersNumber() Gets the total number of members contained into the object for which the JavaDoc coverage statistics is being computed.
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.
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 params doesn't have documentation, only each individual param may have.

Methods inherited from class com.manoelcampos.javadoc.coverage.stats.MethodTagsDocStats

getDocumentedMembers

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()

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

getTagName

public String getTagName()

Description copied from class: MethodTagsDocStats

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

Specified by:

getTagName in class MethodTagsDocStats

Returns:

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 params doesn't have documentation, only each individual param may have.

Overrides:

hasDocumentation in class MethodTagsDocStats

Returns: