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

All Known Implementing Classes:

FieldWriterImpl, HtmlSerialFieldWriter

public interface FieldWriter

The interface for writing field 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 field) Write the comments for the given field.
void	writeDeprecated(FieldDoc field) Write the deprecated output for the given field.
void	writeFieldFooter() Write the field footer.
void	writeFieldHeader(FieldDoc field, boolean isFirst) Write the field header for the given field.
void	writeFooter(ClassDoc classDoc) Write the footer for the field documentation.
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the field documentation.
void	writeSignature(FieldDoc field) Write the signature for the given field.
void	writeTags(FieldDoc field) Write the tag output for the given field.

Method Detail

writeHeader

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

Write the header for the field documentation.

Parameters:

classDoc - the class that the fields belong to.

header - the header to write.

writeFieldHeader

void writeFieldHeader(FieldDoc field,
                      boolean isFirst)

Write the field header for the given field.

Parameters:

field - the field being documented.

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

writeSignature

void writeSignature(FieldDoc field)

Write the signature for the given field.

Parameters:

field - the field being documented.

writeDeprecated

void writeDeprecated(FieldDoc field)

Write the deprecated output for the given field.

Parameters:

field - the field being documented.

writeComments

void writeComments(FieldDoc field)

Write the comments for the given field.

Parameters:

field - the field being documented.

writeTags

void writeTags(FieldDoc field)

Write the tag output for the given field.

Parameters:

field - the field being documented.

writeFieldFooter

void writeFieldFooter()

Write the field footer.

writeFooter

void writeFooter(ClassDoc classDoc)

Write the footer for the field documentation.

Parameters:

classDoc - the class that the fields belong to.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException