com.sdl.dxa.javadoc

Class PublicApiDoclet

java.lang.Object

com.sdl.dxa.javadoc.PublicApiDoclet

public class PublicApiDoclet
extends Object

Doclet that supports custom Javadoc tag dxa.publicApi to decide whether the element should be included in JavaDoc.

The following list of elements is included:

• RootDoc always
• Any element with @dxa.publicApi [optional text] tag set in its javadoc
• Any package that contains an included element
• Any class that contains an included element

All the transitive inclusions happen only upstream, meaning e.g. that class is included if method is included, but method is not included simply because class is. This has been done intentionally to motivate to include as less as possible, and kind of force to write comments to each inclusion.

See Also:

How to use this Doclet in Maven

Method Summary

Modifier and Type	Method and Description
static boolean	isPublicApiDoc(com.sun.javadoc.Doc doc, Set<String> parentPackages, Set<String> parentClasses)
static int	optionLength(String option)
static boolean	start(com.sun.javadoc.RootDoc root)
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter)

Methods inherited from class java.lang.Object

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

Method Detail

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)

optionLength

public static int optionLength(String option)

start

public static boolean start(com.sun.javadoc.RootDoc root)

isPublicApiDoc

public static boolean isPublicApiDoc(com.sun.javadoc.Doc doc,
                                     Set<String> parentPackages,
                                     Set<String> parentClasses)