de.smartics.analysis.javadoc
Class CollectorDoclet

java.lang.Object
  de.smartics.analysis.javadoc.CollectorDoclet

public final class CollectorDoclet
     
     

      
      extends 
      
      Object
     
     

The doclet to interface with the Javadoc tool. It provides the static methods to be called by the Javadoc tool and will collect the relevant Doc elements in the collector context.

Author:

Robert Reiner

Method Summary

static com.sun.javadoc.LanguageVersion	languageVersion() Return the version of the Java Programming Language supported by this doclet.
static boolean	start(com.sun.javadoc.RootDoc root) Runs the doclets.

Methods inherited from class java.lang.Object

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

Method Detail

start

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

Runs the doclets.

Parameters:

root - the root to the documentation parsed from the source file.

Returns:

true on success.

languageVersion

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

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

Returns:

the language version supported by this doclet, 1.5 in this case.

Since:

1.5