Interface MethodWriter
- All Known Implementing Classes:
HtmlSerialMethodWriter
,MethodWriterImpl
Deprecated.
The interface for writing method output.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.5
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addComments
(Type holder, MethodDoc method, Content methodDocTree) Deprecated.Add the comments for the given method.void
addDeprecated
(MethodDoc method, Content methodDocTree) Deprecated.Add the deprecated output for the given method.void
Deprecated.Add the tags for the given method.void
close()
Deprecated.Close the writer.getMethodDetails
(Content methodDetailsTree) Deprecated.Get the method details tree.getMethodDetailsTreeHeader
(ClassDoc classDoc, Content memberDetailsTree) Deprecated.Get the method details tree header.getMethodDoc
(Content methodDocTree, boolean isLastContent) Deprecated.Get the method documentation.getMethodDocTreeHeader
(MethodDoc method, Content methodDetailsTree) Deprecated.Get the method documentation tree header.getSignature
(MethodDoc method) Deprecated.Get the signature for the given method.
-
Method Details
-
getMethodDetailsTreeHeader
Deprecated.Get the method details tree header.- Parameters:
classDoc
- the class being documentedmemberDetailsTree
- the content tree representing member details- Returns:
- content tree for the method details header
-
getMethodDocTreeHeader
Deprecated.Get the method documentation tree header.- Parameters:
method
- the method being documentedmethodDetailsTree
- the content tree representing method details- Returns:
- content tree for the method documentation header
-
getSignature
Deprecated.Get the signature for the given method.- Parameters:
method
- the method being documented- Returns:
- content tree for the method signature
-
addDeprecated
Deprecated.Add the deprecated output for the given method.- Parameters:
method
- the method being documentedmethodDocTree
- content tree to which the deprecated information will be added
-
addComments
Deprecated.Add the comments for the given method.- Parameters:
holder
- the holder type (not erasure) of the methodmethod
- the method being documentedmethodDocTree
- the content tree to which the comments will be added
-
addTags
Deprecated.Add the tags for the given method.- Parameters:
method
- the method being documentedmethodDocTree
- the content tree to which the tags will be added
-
getMethodDetails
Deprecated.Get the method details tree.- Parameters:
methodDetailsTree
- the content tree representing method details- Returns:
- content tree for the method details
-
getMethodDoc
Deprecated.Get the method documentation.- Parameters:
methodDocTree
- the content tree representing method documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the method documentation
-
close
Deprecated.Close the writer.- Throws:
IOException
-