Javadoc (Speedment - Common - CodeGen 3.2.10 API)

All Superinterfaces:

HasCall<Javadoc>, HasCopy<Javadoc>, HasImports<Javadoc>, HasJavadocTags<Javadoc>, HasParent<HasJavadoc<?>,Javadoc>
```
public interface Javadoc
extends HasParent<HasJavadoc<?>,Javadoc>, HasImports<Javadoc>, HasCopy<Javadoc>, HasCall<Javadoc>, HasJavadocTags<Javadoc>
```
A model that represents a block of documentation in code.

Since:

2.0

Author:

Emil Forslund

See Also:

JavadocTag

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getText()`	Returns the body text shown in the javadoc.
`static Javadoc`	`of()`	Creates a new instance implementing this interface by using the default implementation.
`static Javadoc`	`of(String text)`	Creates a new instance implementing this interface by using the default implementation.
`Javadoc`	`setText(String text)`	Sets the body text shown in the javadoc.

Methods inherited from interface com.speedment.common.codegen.model.trait.HasCall
call, call

Methods inherited from interface com.speedment.common.codegen.model.trait.HasCopy
copy

Methods inherited from interface com.speedment.common.codegen.model.trait.HasImports
add, getImports, imports, imports, imports

Methods inherited from interface com.speedment.common.codegen.model.trait.HasJavadocTags
add, author, getTags, param, returns, see, since

Methods inherited from interface com.speedment.common.codegen.model.trait.HasParent
getParent, setParent

- Method Detail
  - setText
```
Javadoc setText(String text)
```
    Sets the body text shown in the javadoc.
    
    Parameters:
    
    text - the text
    
    Returns:
    
    a reference to this model
  - getText
```
String getText()
```
    Returns the body text shown in the javadoc.
    
    Returns:
    
    the body documentation text
  - of
```
static Javadoc of()
```
    Creates a new instance implementing this interface by using the default implementation.
    
    Returns:
    
    the new instance
  - of
```
static Javadoc of(String text)
```
    Creates a new instance implementing this interface by using the default implementation.
    
    Parameters:
    
    text - the documentation
    
    Returns:
    
    the new instance