com.manoelcampos.javadoc.coverage.stats

Class ClassDocStats

java.lang.Object

com.manoelcampos.javadoc.coverage.stats.MembersDocStats

com.manoelcampos.javadoc.coverage.stats.ClassDocStats

All Implemented Interfaces:

DocStats

public class ClassDocStats
extends MembersDocStats

Computes statistics about the JavaDocs of a class, inner class, interface or enum and its members, such as: fields, methods, constructors and annotations.

Since:

1.0.0

Author:

Manoel Campos da Silva Filho

Constructor Summary

Constructors

Constructor and Description
ClassDocStats(com.sun.javadoc.ClassDoc doc)

Method Summary

Modifier and Type	Method and Description
ClassMembersDocStats	getAnnotationsStats()
List<MethodDocStats>	getConstructorsStats()
com.sun.javadoc.ClassDoc	getDoc()
long	getDocumentedMembers() Gets the number of documented members contained into the object for which the JavaDoc coverage statistics is being computed.
ClassMembersDocStats	getEnumsStats()
ClassMembersDocStats	getFieldsStats()
long	getMembersNumber() Gets the total number of members contained into the object for which the JavaDoc coverage statistics is being computed.
List<MethodDocStats>	getMethodsStats()
String	getName()
String	getPackageName()
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.

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

Constructor Detail

ClassDocStats

public ClassDocStats(com.sun.javadoc.ClassDoc doc)

Method Detail

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

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

getName

public String getName()

getPackageName

public String getPackageName()

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

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

getFieldsStats

public ClassMembersDocStats getFieldsStats()

getEnumsStats

public ClassMembersDocStats getEnumsStats()

getAnnotationsStats

public ClassMembersDocStats getAnnotationsStats()

getMethodsStats

public List<MethodDocStats> getMethodsStats()

getConstructorsStats

public List<MethodDocStats> getConstructorsStats()

getDoc

public com.sun.javadoc.ClassDoc getDoc()