Package com.nomagic.reportwizard.tools.doc

Class JavaDocTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.reportwizard.tools.doc.JavaDocTool

All Implemented Interfaces:

ITool, IVariable, Serializable, Cloneable

@OpenApiAll
public class JavaDocTool
extends Tool

Provide the function to create Document for the JavaDoc.

Since:

Sep 3, 2008

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

ITool.HTMLString, ITool.RetainedString, ITool.Void

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor	Description
JavaDocTool()

Method Summary

Modifier and Type	Method	Description
Document	create(String comment)	Create and return a instance of Document.
Document	createForText(String comment)	Create and return a instance of Document.

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicreport.engine.ITool

clearTool

Constructor Details

JavaDocTool

public JavaDocTool()

Method Details

create

public Document create(String comment)

Create and return a instance of Document. The JavaDoc comment must be started with /** and end with */.

Parameters:

comment - comment text

Returns:

a new instance of Document

See Also:

• DocumentParser.parse(String)

createForText

public Document createForText(String comment)

Create and return a instance of Document.

Parameters:

comment - comment text

Returns:

a new instance of Document