Class TraditionalJavadocToMarkdown

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.javadoc.TraditionalJavadocToMarkdown

All Implemented Interfaces:

BugChecker.ClassTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.ModuleTreeMatcher, BugChecker.PackageTreeMatcher, BugChecker.VariableTreeMatcher, Suppressible, Serializable

public final class TraditionalJavadocToMarkdown
extends BugChecker
implements BugChecker.ClassTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.VariableTreeMatcher, BugChecker.PackageTreeMatcher, BugChecker.ModuleTreeMatcher

An experimental tool that converts traditional Javadoc comments to Markdown Javadoc comments.

Note that malformed traditional Javadocs will likely result in malformed Markdown Javadocs ("garbage in, garbage out").

WARNING: this tool is currently a prototype and may have bugs.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class BugChecker

BugChecker.AnnotatedTypeTreeMatcher, BugChecker.AnnotationTreeMatcher, BugChecker.ArrayAccessTreeMatcher, BugChecker.ArrayTypeTreeMatcher, BugChecker.AssertTreeMatcher, BugChecker.AssignmentTreeMatcher, BugChecker.BinaryTreeMatcher, BugChecker.BindingPatternTreeMatcher, BugChecker.BlockTreeMatcher, BugChecker.BreakTreeMatcher, BugChecker.CaseTreeMatcher, BugChecker.CatchTreeMatcher, BugChecker.ClassTreeMatcher, BugChecker.CompilationUnitTreeMatcher, BugChecker.CompoundAssignmentTreeMatcher, BugChecker.ConditionalExpressionTreeMatcher, BugChecker.ConstantCaseLabelTreeMatcher, BugChecker.ContinueTreeMatcher, BugChecker.DeconstructionPatternTreeMatcher, BugChecker.DefaultCaseLabelTreeMatcher, BugChecker.DoWhileLoopTreeMatcher, BugChecker.EmptyStatementTreeMatcher, BugChecker.EnhancedForLoopTreeMatcher, BugChecker.ExportsTreeMatcher, BugChecker.ExpressionStatementTreeMatcher, BugChecker.ForLoopTreeMatcher, BugChecker.IdentifierTreeMatcher, BugChecker.IfTreeMatcher, BugChecker.ImportTreeMatcher, BugChecker.InstanceOfTreeMatcher, BugChecker.IntersectionTypeTreeMatcher, BugChecker.LabeledStatementTreeMatcher, BugChecker.LambdaExpressionTreeMatcher, BugChecker.LiteralTreeMatcher, BugChecker.MemberReferenceTreeMatcher, BugChecker.MemberSelectTreeMatcher, BugChecker.MethodInvocationTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.ModifiersTreeMatcher, BugChecker.ModuleTreeMatcher, BugChecker.NewArrayTreeMatcher, BugChecker.NewClassTreeMatcher, BugChecker.OpensTreeMatcher, BugChecker.PackageTreeMatcher, BugChecker.ParameterizedTypeTreeMatcher, BugChecker.ParenthesizedTreeMatcher, BugChecker.PatternCaseLabelTreeMatcher, BugChecker.PrimitiveTypeTreeMatcher, BugChecker.ProvidesTreeMatcher, BugChecker.RequiresTreeMatcher, BugChecker.ReturnTreeMatcher, BugChecker.SuppressibleTreePathScanner<R,P>, BugChecker.SwitchExpressionTreeMatcher, BugChecker.SwitchTreeMatcher, BugChecker.SynchronizedTreeMatcher, BugChecker.ThrowTreeMatcher, BugChecker.TryTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.TypeParameterTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.UnionTypeTreeMatcher, BugChecker.UsesTreeMatcher, BugChecker.VariableTreeMatcher, BugChecker.WhileLoopTreeMatcher, BugChecker.WildcardTreeMatcher, BugChecker.YieldTreeMatcher

Constructor Summary

Constructors

Constructor	Description
TraditionalJavadocToMarkdown()

Method Summary

Modifier and Type	Method	Description
Description	matchClass(ClassTree tree, VisitorState state)
Description	matchMethod(MethodTree tree, VisitorState state)
Description	matchModule(ModuleTree tree, VisitorState state)
Description	matchPackage(PackageTree tree, VisitorState state)
Description	matchVariable(VariableTree tree, VisitorState state)

Methods inherited from class BugChecker

allNames, buildDescription, buildDescription, buildDescription, buildDescription, canonicalName, customSuppressionAnnotations, defaultSeverity, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, disableable, equals, hashCode, isSuppressed, isSuppressed, linkUrl, message, supportsSuppressWarnings, suppressedByAnyOf, suppressedRegions

Methods inherited from class Object

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

Methods inherited from interface Suppressible

allNames, canonicalName, customSuppressionAnnotations, supportsSuppressWarnings, suppressedByAnyOf

Constructor Details

TraditionalJavadocToMarkdown

public TraditionalJavadocToMarkdown()

Method Details

matchClass

public Description matchClass(ClassTree tree,
 VisitorState state)

Specified by:

matchClass in interface BugChecker.ClassTreeMatcher

matchMethod

public Description matchMethod(MethodTree tree,
 VisitorState state)

Specified by:

matchMethod in interface BugChecker.MethodTreeMatcher

matchVariable

public Description matchVariable(VariableTree tree,
 VisitorState state)

Specified by:

matchVariable in interface BugChecker.VariableTreeMatcher

matchPackage

public Description matchPackage(PackageTree tree,
 VisitorState state)

Specified by:

matchPackage in interface BugChecker.PackageTreeMatcher

matchModule

public Description matchModule(ModuleTree tree,
 VisitorState state)

Specified by:

matchModule in interface BugChecker.ModuleTreeMatcher