zserio.extension.cpp

Class DocCommentsTemplateData

java.lang.Object

zserio.extension.cpp.DocCommentsTemplateData

public final class DocCommentsTemplateData
extends java.lang.Object

FreeMarker template data for documentation comments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocCommentsTemplateData.DocMultilineData
static class	DocCommentsTemplateData.DocParagraphData
static class	DocCommentsTemplateData.DocTagParamData
static class	DocCommentsTemplateData.DocTagSeeData

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<DocCommentsTemplateData.DocParagraphData>	getParagraphs()

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.cpp.TemplateDataContext context,
                               java.util.List<DocComment> docComments)
                        throws ZserioExtensionException

Throws:

ZserioExtensionException

Method Detail

getParagraphs

public java.lang.Iterable<DocCommentsTemplateData.DocParagraphData> getParagraphs()