com.ibm.cloud.objectstorage.annotation

Class ExcludeDoclet

java.lang.Object

com.sun.tools.doclets.standard.Standard

com.ibm.cloud.objectstorage.annotation.ExcludeDoclet

public class ExcludeDoclet
extends com.sun.tools.doclets.standard.Standard

This class is used to create an annotation which can exclude methods & variables from java doc generation. This class is excluded from the main maven build as it relies on Jars which are not installed by default Java 1.9 upwards. Is is only compiled when using the docgen profile and only required by the this profile to generate docs which exclude non supported features.

Constructor Summary

Constructors

Constructor and Description
ExcludeDoclet()

Method Summary

Modifier and Type	Method and Description
static boolean	start(com.sun.javadoc.RootDoc rootIBMDoc)

Methods inherited from class com.sun.tools.doclets.standard.Standard

languageVersion, optionLength, validOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcludeDoclet

public ExcludeDoclet()

Method Detail

start

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