org.esa.beam.framework.gpf.doclet
Class OperatorDoclet

java.lang.Object
  com.sun.javadoc.Doclet
      org.esa.beam.framework.gpf.doclet.OperatorDoclet

public class OperatorDoclet
extends com.sun.javadoc.Doclet

A doclet which scans the classpath for GPF operators and creates associated documentation derived from an operator's annotations

1. OperatorMetadata
2. SourceProduct
3. SourceProducts
4. TargetProduct
5. Parameter

This Doclet can be called on Windows from the command line by the following instruction. NOTE: You have to adopt the pathes to your needs.

  SET DocletClassName=org.esa.beam.framework.gpf.doclet.OperatorDoclet
  SET SourcePath=.\beam-gpf\src\main\java
  SET ClassPath=.\beam-gpf\target\classes
 

 javadoc -doclet "%DocletClassName%" -docletpath "%DocletPath%" ^
         -sourcepath "%SourcePath%" -classpath "%ClassPath%" ^
         org.esa.beam.gpf.operators.std
 

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Constructor Summary

OperatorDoclet()

Method Summary

static com.sun.javadoc.LanguageVersion	languageVersion()
static void	main(String[] args)
static int	optionLength(String optionName)
static boolean	start(com.sun.javadoc.RootDoc root)
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter docErrorReporter)

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorDoclet

public OperatorDoclet()

Method Detail

main

public static void main(String[] args)

start

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

optionLength

public static int optionLength(String optionName)

validOptions

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

languageVersion

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