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

All Known Implementing Classes:

HtmlSerialMethodWriter, MethodWriterImpl

public interface MethodWriter

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

Method Detail

writeHeader

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

Write the header for the method documentation.

Parameters:

classDoc - the class that the methods belong to.

header - the header to write.

writeMethodHeader

void writeMethodHeader(MethodDoc method,
                       boolean isFirst)

Write the method header for the given method.

Parameters:

method - the method being documented.

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

writeSignature

void writeSignature(MethodDoc method)

Write the signature for the given method.

Parameters:

method - the method being documented.

writeDeprecated

void writeDeprecated(MethodDoc method)

Write the deprecated output for the given method.

Parameters:

method - the method being documented.

writeComments

void writeComments(Type holder,
                   MethodDoc method)

Write the comments for the given method.

Parameters:

holder - the holder type (not erasure) of the method.

method - the method being documented.

writeTags

void writeTags(MethodDoc method)

Write the tag output for the given method.

Parameters:

method - the method being documented.

writeMethodFooter

void writeMethodFooter()

Write the method footer.

writeFooter

void writeFooter(ClassDoc classDoc)

Write the footer for the method documentation.

Parameters:

classDoc - the class that the methods belong to.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException