com.rychlik.jode
Class ParameterInfo

java.lang.Object
  extended by com.rychlik.jode.ParameterInfo

public class ParameterInfo
extends java.lang.Object

Documents parameters accepted by the JOdeApplet


Field Summary
static java.lang.String[][] docstrings
           
static int HTML
          The constant HTML represents HTML output format.
static int SYNOPSIS
          The constant SYNONYMOUS represents the Unix-like synopsis output format.
 
Constructor Summary
ParameterInfo()
           
 
Method Summary
static void dump()
          Print the information about parameters and their default values as an HTML table to System.out
static void dump(java.io.PrintStream out, int format)
          The dump method prints documentation of JOde arguments in various formats.
static void dump(java.lang.String filename)
          Describe dump method here.
static void dump(java.lang.String filename, int format)
          Describe dump method here.
static void dumpHTML(java.io.PrintStream out)
          Print the information about parameters and their default values as an HTML table
static void dumpSynopsis(java.io.PrintStream out)
          The dumpSynopsis method prints the synopsis of JOde arguments.
static void synopsis()
          The synopsis method prints synopsis of JOde arguments to standard output.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTML

public static final int HTML
The constant HTML represents HTML output format.

See Also:
Constant Field Values

SYNOPSIS

public static final int SYNOPSIS
The constant SYNONYMOUS represents the Unix-like synopsis output format.

See Also:
Constant Field Values

docstrings

public static final java.lang.String[][] docstrings
Constructor Detail

ParameterInfo

public ParameterInfo()
Method Detail

dumpHTML

public static void dumpHTML(java.io.PrintStream out)
Print the information about parameters and their default values as an HTML table

Parameters:
out - Print stream

dumpSynopsis

public static void dumpSynopsis(java.io.PrintStream out)
The dumpSynopsis method prints the synopsis of JOde arguments.

Parameters:
out - a PrintStream value

dump

public static void dump(java.io.PrintStream out,
                        int format)
The dump method prints documentation of JOde arguments in various formats.

Parameters:
out - a PrintStream value
format - an int value

dump

public static void dump(java.lang.String filename,
                        int format)
Describe dump method here.

Parameters:
filename - a String value
format - an int value

dump

public static void dump(java.lang.String filename)
Describe dump method here.

Parameters:
filename - a String value

dump

public static void dump()
Print the information about parameters and their default values as an HTML table to System.out


synopsis

public static void synopsis()
The synopsis method prints synopsis of JOde arguments to standard output.