io.sundr.model

Interface Commentable

All Superinterfaces:

Node

All Known Implementing Classes:

Method, Property, TypeDef

public interface Commentable
extends Node

Field Summary

Fields inherited from interface io.sundr.model.Node

AT, CB, CC, CLP, COMA, CP, DOT, DQ, EQ, EXTENDS, GT, IMPLEMENTS, JAVA_LANG, JAVA_LANG_ENUM, JAVA_LANG_OBJECT, JAVA_LANG_STRING, LT, NEWLINE, OB, OC, OP, Q, SEMICOLN, SPACE, STAR, THROWS, VARARG

Method Summary

Modifier and Type	Method and Description
List<String>	getComments() Get the list of comments.
default String	renderComments(String indent) Render the comments.

Method Detail

getComments

List<String> getComments()

Get the list of comments.

Returns:

a List of comments.

renderComments

default String renderComments(String indent)

Render the comments.

Parameters:

indent - the identation to use for the comments

Returns:

the rendered comments as a string.