zserio.extension.doc

Class DocCommentsTemplateData

java.lang.Object

zserio.extension.doc.DocCommentsTemplateData

public final class DocCommentsTemplateData
extends java.lang.Object

FreeMarker template data for documentation comments in the package used by Package emitter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocCommentsTemplateData.DocCommentTemplateData

Constructor Summary

Constructors

Constructor and Description
DocCommentsTemplateData(zserio.extension.doc.ContentTemplateDataContext context, java.util.List<DocComment> docComments)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<DocCommentsTemplateData.DocCommentTemplateData>	getFloatingCommentsList()
boolean	getIsDeprecated()
java.lang.Iterable<DocCommentsTemplateData.DocCommentTemplateData>	getStickyCommentsList()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocCommentsTemplateData

public DocCommentsTemplateData(zserio.extension.doc.ContentTemplateDataContext context,
                               java.util.List<DocComment> docComments)

Method Detail

getFloatingCommentsList

public java.lang.Iterable<DocCommentsTemplateData.DocCommentTemplateData> getFloatingCommentsList()

getStickyCommentsList

public java.lang.Iterable<DocCommentsTemplateData.DocCommentTemplateData> getStickyCommentsList()

getIsDeprecated

public boolean getIsDeprecated()