ConForM.CoopnTools.DocV
Class DocV

java.lang.Object
  |
  +--ConForM.CoopnTools.DocV.DocV
All Implemented Interfaces:
CoopnTool, java.lang.Runnable

public class DocV
extends java.lang.Object
implements CoopnTool

CoopnTools documentation viewer. This tool allows to browse the documentation generated form the documentation coments included in source files.

See Also:
run

Field Summary
static java.lang.String TOOL
          Formatter tool name.
static java.lang.String VERSION
          Formatter version.
 
Constructor Summary
protected DocV(DocVEnv env, DocVEnvMgr envMgr)
          Simple constructor.
 
Method Summary
 CoopnEnv getEnv()
          Get the environment.
static DocV getTool(CoopnEnv env)
          Creates a new document viewer, based on an existing environment, or null if the tool cannot be created.
static DocV getTool(DocVEnv env)
          Creates a new document generator, based on an existing environment, or null if the tool cannot be created.
static void main(java.lang.String[] args)
          Main program.
 void run()
          Implementation of the formatter.
 void show()
          Show the tool's window, if the tool has its own GUI.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION

public static final java.lang.String VERSION
Formatter version.

TOOL

public static final java.lang.String TOOL
Formatter tool name.
Constructor Detail

DocV

protected DocV(DocVEnv env,
               DocVEnvMgr envMgr)
Simple constructor.
Parameters:
env - an environment manager containing a specific environment for the formatter
Method Detail

getTool

public static DocV getTool(CoopnEnv env)
Creates a new document viewer, based on an existing environment, or null if the tool cannot be created.

getTool

public static DocV getTool(DocVEnv env)
Creates a new document generator, based on an existing environment, or null if the tool cannot be created.

getEnv

public CoopnEnv getEnv()
Get the environment.
Specified by:
getEnv in interface CoopnTool

show

public void show()
Show the tool's window, if the tool has its own GUI. Do nothing else.
Specified by:
show in interface CoopnTool

run

public void run()
Implementation of the formatter.
Specified by:
run in interface java.lang.Runnable

main

public static void main(java.lang.String[] args)
Main program. This method creates a new environment from the command line, creates a new checker according to the environment, and call its run method.