Package org.apache.yetus.audience.tools

Class IncludePublicAnnotationsStandardDoclet

java.lang.Object

jdk.javadoc.doclet.StandardDoclet

org.apache.yetus.audience.tools.ExcludePrivateAnnotationsStandardDoclet

org.apache.yetus.audience.tools.IncludePublicAnnotationsStandardDoclet

All Implemented Interfaces:

Doclet

@Public
@Evolving
public class IncludePublicAnnotationsStandardDoclet
extends ExcludePrivateAnnotationsStandardDoclet

A Doclet that only includes class-level elements that are annotated with InterfaceAudience.Public. Class-level elements with no annotation are excluded. In addition, all elements that are annotated with InterfaceAudience.Private or InterfaceAudience.LimitedPrivate are also excluded. It delegates to the Standard Doclet, and takes the same options.

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Field Summary

Fields inherited from class org.apache.yetus.audience.tools.ExcludePrivateAnnotationsStandardDoclet

processor

Constructor Summary

Constructors

Constructor	Description
IncludePublicAnnotationsStandardDoclet()

Method Summary

Modifier and Type	Method	Description
String	getName()
void	init(Locale locale, Reporter reporter)

Methods inherited from class org.apache.yetus.audience.tools.ExcludePrivateAnnotationsStandardDoclet

getSupportedOptions, run

Methods inherited from class jdk.javadoc.doclet.StandardDoclet

getSupportedSourceVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludePublicAnnotationsStandardDoclet

public IncludePublicAnnotationsStandardDoclet()

Method Detail

init

public void init(Locale locale,
                 Reporter reporter)

Specified by:

init in interface Doclet

Overrides:

init in class StandardDoclet

getName

public String getName()

Specified by:

getName in interface Doclet