com.carma.swagger.doclet

Class ServiceDoclet

java.lang.Object

com.carma.swagger.doclet.ServiceDoclet

public class ServiceDoclet
extends Object

Constructor Summary

Constructors

Constructor and Description
ServiceDoclet()

Method Summary

Methods

Modifier and Type	Method and Description
static com.sun.javadoc.LanguageVersion	languageVersion() Return the version of the Java Programming Language supported by this doclet.
static int	optionLength(String option) Check for doclet-added options.
static boolean	start(com.sun.javadoc.RootDoc doc) Generate documentation here.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceDoclet

public ServiceDoclet()

Method Detail

start

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

Generate documentation here. This method is required for all doclets.

Parameters:

doc - The root doc

Returns:

true on success.

optionLength

public static int optionLength(String option)

Check for doclet-added options. Returns the number of arguments you must specify on the command line for the given option. For example, "-d docs" would return 2.

This method is required if the doclet contains any options. If this method is missing, Javadoc will print an invalid flag error for every option.

Parameters:

option - The option to check

Returns:

number of arguments on the command line for an option including the option name itself. Zero return means option not known. Negative value means error occurred.

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

Return the version of the Java Programming Language supported by this doclet.

This method is required by any doclet supporting a language version newer than 1.1.

Returns:

the language version supported by this doclet.

Since:

1.5