com.neeve.asm

Class AsmDocumentation

java.lang.Object

com.neeve.root.RootObject

com.neeve.asm.AsmObject

com.neeve.asm.AsmModelElement

com.neeve.asm.AsmDocumentation

public class AsmDocumentation
extends AsmModelElement

Used to model documentation for model elements.

Field Summary

Fields inherited from class com.neeve.root.RootObject

checked, threaded, tracer

Method Summary

Modifier and Type	Method and Description
String	getBrief() Returns the brief (intended to be one line) documentation.
String	getFull() Gets the full, multi-line documentation.
void	setBrief(String brief) Sets the brief (intended to be one line) documentation.
void	setFull(String full) Sets the full, multi-line documentation.

Methods inherited from class com.neeve.asm.AsmModelElement

getCodeSource, setCodeSource

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer, setChecked, setDefaultTracePrefix, setTracer

Methods inherited from class java.lang.Object

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

Method Detail

getBrief

public final String getBrief()

Returns the brief (intended to be one line) documentation.

Returns:

The brief documentation.

setBrief

public final void setBrief(String brief)

Sets the brief (intended to be one line) documentation.

Parameters:

brief - Set the brief (one line) documentation.

getFull

public final String getFull()

Gets the full, multi-line documentation. This documenation may include the limited set of html tags permitted by javadoc, and it will be used as is to generate javadoc.

Returns:

The full documentation String.

setFull

public final void setFull(String full)

Sets the full, multi-line documentation. This documenation may include the limited set of html tags permitted by javadoc, and it will be used as is to generate javadoc.

Parameters:

full - The full documentation String.