org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc

Class DefaultJavaDocRenderer

java.lang.Object

org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.DefaultJavaDocRenderer

All Implemented Interfaces:

JavaDocRenderer

public class DefaultJavaDocRenderer
extends Object
implements JavaDocRenderer

Default JavaDocRenderer implementation which provides a plain JavaDocData rendering, on the form:

     [JavaDoc comment]
     (tag1): [tag1 value]
     (tag2): [tag2 value]
 

Since:

2.0

Author:

Lennart Jörelid, jGuru Europe AB

Constructor Summary

Constructors

Constructor and Description
DefaultJavaDocRenderer()

Method Summary

Modifier and Type	Method and Description
String	render(JavaDocData nonNullData, SortableLocation location) Renders the supplied JavaDocData structure as text to be used within an XSD documentation annotation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJavaDocRenderer

public DefaultJavaDocRenderer()

Method Detail

render

public String render(JavaDocData nonNullData,
                     SortableLocation location)

Renders the supplied JavaDocData structure as text to be used within an XSD documentation annotation. The XSD documentation annotation will contain a CDATA section to which the rendered JavaDocData is emitted.

Specified by:

render in interface JavaDocRenderer

Parameters:

nonNullData - the JavaDocData instance to render as XSD documentation. Will never be null.

location - the SortableLocation where the JavaDocData was harvested. Never null.

Returns:

The rendered text contained within the XML annotation.