Class Javadoc

java.lang.Object

org.sonar.java.checks.helpers.Javadoc

public final class Javadoc
extends Object

Provides information about tags in JavaDoc and Markdown documentation comments.

Constructor Summary

Constructors

Constructor	Description
Javadoc(Tree tree)

Method Summary

Modifier and Type	Method	Description
boolean	noMainDescription()
boolean	noReturnDescription()
Set<String>	undocumentedParameters()
Set<String>	undocumentedThrownExceptions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Javadoc

public Javadoc(Tree tree)

Method Details

noMainDescription

public boolean noMainDescription()

noReturnDescription

public boolean noReturnDescription()

undocumentedParameters

public Set<String> undocumentedParameters()

undocumentedThrownExceptions

public Set<String> undocumentedThrownExceptions()