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]
| Constructor and Description |
|---|
DefaultJavaDocRenderer() |
| Modifier and Type | Method and Description |
|---|---|
protected String |
harmonizeNewlines(String original)
Squashes newline characters into
|
String |
render(JavaDocData nonNullData,
SortableLocation location)
Renders the supplied JavaDocData structure as text to be used within an XSD documentation annotation.
|
protected String |
renderJavaDocComment(String comment,
SortableLocation location)
Override this method to yield another rendering of the javadoc comment.
|
protected String |
renderJavaDocTag(String name,
String value,
SortableLocation location)
Override this method to yield another
|
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.
render in interface JavaDocRenderernonNullData - the JavaDocData instance to render as XSD documentation. Will never be null.location - the SortableLocation where the JavaDocData was harvested. Never null.protected String renderJavaDocComment(String comment, SortableLocation location)
comment - The comment to render.location - the SortableLocation where the JavaDocData was harvested. Never null.protected String renderJavaDocTag(String name, String value, SortableLocation location)
name - The name of a JavaDoc tag.value - The value of a JavaDoc tag.location - the SortableLocation where the JavaDocData was harvested. Never null.Copyright © 2005–2018 MojoHaus. All rights reserved.