multex.tool
Class ExceptionMessagesDoclet

java.lang.Object
  multex.tool.ExceptionMessagesDoclet

public class ExceptionMessagesDoclet

extends java.lang.Object

This doclet collects the exception message text pattern of each concrete Throwable-subclass. Scans all sources, takes the javadoc main comment text of each concrete subclass of Throwable, and appends all of them to the file given by the Doclet option -out

Nested Class Summary

static class

ExceptionMessagesDoclet.TooNestedThrowableException Throwable class {canonicalName} has more than one nesting level.

Constructor Summary

ExceptionMessagesDoclet()

Method Summary

static int	optionLength(java.lang.String option) Check for doclet-added options.
static boolean	start(RootDoc i_rootDoc) Entry point to execute this Doclet.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionMessagesDoclet

public ExceptionMessagesDoclet()

Method Detail

optionLength

public static int optionLength(java.lang.String option)

Check for doclet-added options. Only one option is allowed her: -out filename

Parameters:

option - the name of the option including the minus character, for example "-out".

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.

start

public static boolean start(RootDoc i_rootDoc)
                     throws java.lang.Exception

Entry point to execute this Doclet. It will be invoked by the Javadoc tool.

Throws:

java.lang.Exception