public class PublicApiDoclet extends Object
dxa.publicApi to decide whether the element should be included in JavaDoc.
The following list of elements is included:
RootDoc always@dxa.publicApi [optional text] tag set in its javadocAll 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.
| 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) |
Copyright © 2015–2018 SDL. All rights reserved.