com.sun.tools.doclets.internal.toolkit
Interface EnumConstantWriter

All Known Implementing Classes:

EnumConstantWriterImpl

public interface EnumConstantWriter

The interface for writing enum constant output. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:

1.5

Method Summary

void	close() Close the writer.
void	writeComments(FieldDoc enumConstant) Write the comments for the given enum constant.
void	writeDeprecated(FieldDoc enumConstant) Write the deprecated output for the given enum constant.
void	writeEnumConstantFooter() Write the enum constant footer.
void	writeEnumConstantHeader(FieldDoc enumConstant, boolean isFirst) Write the enum constant header for the given enum constant.
void	writeFooter(ClassDoc classDoc) Write the footer for the enum constant documentation.
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the enum constant documentation.
void	writeSignature(FieldDoc enumConstant) Write the signature for the given enum constant.
void	writeTags(FieldDoc enumConstant) Write the tag output for the given enum constant.

Method Detail

writeHeader

void writeHeader(ClassDoc classDoc,
                 java.lang.String header)

Write the header for the enum constant documentation.

Parameters:

classDoc - the class that the enum constants belong to.

header - the header to write.

writeEnumConstantHeader

void writeEnumConstantHeader(FieldDoc enumConstant,
                             boolean isFirst)

Write the enum constant header for the given enum constant.

Parameters:

enumConstant - the enum constant being documented.

isFirst - the flag to indicate whether or not the enum constant is the first to be documented.

writeSignature

void writeSignature(FieldDoc enumConstant)

Write the signature for the given enum constant.

Parameters:

enumConstant - the enum constant being documented.

writeDeprecated

void writeDeprecated(FieldDoc enumConstant)

Write the deprecated output for the given enum constant.

Parameters:

enumConstant - the enum constant being documented.

writeComments

void writeComments(FieldDoc enumConstant)

Write the comments for the given enum constant.

Parameters:

enumConstant - the enum constant being documented.

writeTags

void writeTags(FieldDoc enumConstant)

Write the tag output for the given enum constant.

Parameters:

enumConstant - the enum constant being documented.

writeEnumConstantFooter

void writeEnumConstantFooter()

Write the enum constant footer.

writeFooter

void writeFooter(ClassDoc classDoc)

Write the footer for the enum constant documentation.

Parameters:

classDoc - the class that the enum constant belong to.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException