Package net.morimekta.providence.generator.format.java.utils

Class BlockCommentBuilder

java.lang.Object

net.morimekta.providence.generator.format.java.utils.BlockCommentBuilder

public class BlockCommentBuilder
extends java.lang.Object

Builds a proper block javadoc-compatible comment.

Constructor Summary

Constructors

Constructor	Description
BlockCommentBuilder(net.morimekta.util.io.IndentedPrintWriter writer)

Method Summary

Modifier and Type	Method	Description
BlockCommentBuilder	comment(java.lang.String comment)
BlockCommentBuilder	commentRaw(java.lang.String comment)
BlockCommentBuilder	deprecated_(java.lang.String reason)
void	finish()
BlockCommentBuilder	newline()
BlockCommentBuilder	paragraph()
BlockCommentBuilder	param_(java.lang.String name, java.lang.String comment)
BlockCommentBuilder	return_(java.lang.String comment)
BlockCommentBuilder	throws_(java.lang.Class<?> klass, java.lang.String comment)
BlockCommentBuilder	throws_(java.lang.String klass, java.lang.String comment)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockCommentBuilder

public BlockCommentBuilder(net.morimekta.util.io.IndentedPrintWriter writer)

Method Detail

comment

public BlockCommentBuilder comment(java.lang.String comment)

commentRaw

public BlockCommentBuilder commentRaw(java.lang.String comment)

newline

public BlockCommentBuilder newline()

paragraph

public BlockCommentBuilder paragraph()

param_

public BlockCommentBuilder param_(java.lang.String name,
                                  java.lang.String comment)

return_

public BlockCommentBuilder return_(java.lang.String comment)

throws_

public BlockCommentBuilder throws_(java.lang.Class<?> klass,
                                   java.lang.String comment)

throws_

public BlockCommentBuilder throws_(java.lang.String klass,
                                   java.lang.String comment)

deprecated_

public BlockCommentBuilder deprecated_(@Nonnull
                                       java.lang.String reason)

finish

public void finish()