com.hammurapi.config.runtime
Class ConfigDoc

java.lang.Object
  Task
      com.hammurapi.config.runtime.ConfigDoc

public class ConfigDoc
extends Task

Generates HTML documentation for configuration models.

Author:

Pavel Vlasov

Constructor Summary

ConfigDoc()

Method Summary

void	addPath(String pathElement)
void	execute()
File	getOutputDir() Output directory
String	getSource() Source - file or URL
boolean	isHttp()
static void	main(String[] args) Generates documentation from a diagram file.
void	setHttp(boolean http) If true, outline and contents trees are rendered to use AJAX.
void	setOutputDir(File outputDir) Output directory
void	setSource(String source) Source - file or URL
void	setToDocument(org.eclipse.emf.ecore.EObject toDocument)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDoc

public ConfigDoc()

Method Detail

addPath

public void addPath(String pathElement)

setToDocument

public void setToDocument(org.eclipse.emf.ecore.EObject toDocument)

execute

public void execute()
             throws BuildException

Throws:

BuildException

getSource

public String getSource()

Source - file or URL

Returns:

setSource

public void setSource(String source)

Source - file or URL

Parameters:

source -

getOutputDir

public File getOutputDir()

Output directory

Returns:

setOutputDir

public void setOutputDir(File outputDir)

Output directory

Parameters:

outputDir -

isHttp

public boolean isHttp()

setHttp

public void setHttp(boolean http)

If true, outline and contents trees are rendered to use AJAX. It is useful for large models, but works only over HTTP.

Parameters:

http -

main

public static void main(String[] args)
                 throws Exception

Generates documentation from a diagram file. Command line parameters: <diagram file> <output dir> [http]

Parameters:

args -

Throws:

Exception