attrib4j
Class AttributeDoclet

java.lang.Object
  |
  +--attrib4j.AttributeDoclet

public class AttributeDoclet

extends java.lang.Object

A Doclet that emulates (in a post-processing step) the attribute declarations supported by C# and other .NET compilers. It is run over an already-compiled class, using the -doclet option of the javadoc tool; it parses the source, extracts javadoc-style comments of the tag "@attribute", and uses IBM CFParse or Jakarta's BCEL byte code library to insert custom attributes into the compiled .class file metadata. These attributes can later be extracted at runtime.

Version:

$Revision: 1.18 $ $Date: 2003/09/13 06:45:58 $

Author:

Mark Pollack, Ted Neward

Constructor Summary

AttributeDoclet()

Method Summary

static int	optionLength(java.lang.String option) API called by javadoc to determine argument counts on javadoc command-line.
static boolean	start(com.sun.javadoc.RootDoc root) Entry point for the Doclet when invoked from javadoc.
static boolean	validOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter) API called by javadoc to validate arguments on javadoc command-line.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeDoclet

public AttributeDoclet()

Method Detail

start

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

Entry point for the Doclet when invoked from javadoc.

Parameters:

root - a value of type 'RootDoc'

Returns:

a value of type 'boolean'

optionLength

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

API called by javadoc to determine argument counts on javadoc command-line.

Parameters:

option - a value of type 'String'

Returns:

a value of type 'int'

validOptions

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

API called by javadoc to validate arguments on javadoc command-line.

Parameters:

options - the incoming command line args from javadoc command line

reporter - a value of type 'DocErrorReporter'

Returns:

a value of type 'boolean'