Interface AnnotationTypeRequiredMemberWriter
- All Known Subinterfaces:
AnnotationTypeOptionalMemberWriter
- All Known Implementing Classes:
AnnotationTypeOptionalMemberWriterImpl
,AnnotationTypeRequiredMemberWriterImpl
Deprecated.
The interface for writing annotation type required member 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
addAnnotationDetailsMarker
(Content memberDetails) Deprecated.Add the annotation type details marker.void
addAnnotationDetailsTreeHeader
(ClassDoc classDoc, Content memberDetailsTree) Deprecated.Add the annotation type details tree header.void
addComments
(MemberDoc member, Content annotationDocTree) Deprecated.Add the comments for the given member.void
addDeprecated
(MemberDoc member, Content annotationDocTree) Deprecated.Add the deprecated output for the given member.void
Deprecated.Add the tags for the given member.void
close()
Deprecated.Close the writer.getAnnotationDetails
(Content annotationDetailsTree) Deprecated.Get the annotation type details tree.getAnnotationDoc
(Content annotationDocTree, boolean isLastContent) Deprecated.Get the annotation type documentation.getAnnotationDocTreeHeader
(MemberDoc member, Content annotationDetailsTree) Deprecated.Get the annotation type documentation tree header.Deprecated.Add the annotation type member tree header.getSignature
(MemberDoc member) Deprecated.Get the signature for the given member.
-
Method Details
-
getMemberTreeHeader
Content getMemberTreeHeader()Deprecated.Add the annotation type member tree header.- Returns:
- content tree for the member tree header
-
addAnnotationDetailsMarker
Deprecated.Add the annotation type details marker.- Parameters:
memberDetails
- the content tree representing details marker
-
addAnnotationDetailsTreeHeader
Deprecated.Add the annotation type details tree header.- Parameters:
classDoc
- the annotation type being documentedmemberDetailsTree
- the content tree representing member details
-
getAnnotationDocTreeHeader
Deprecated.Get the annotation type documentation tree header.- Parameters:
member
- the annotation type being documentedannotationDetailsTree
- the content tree representing annotation type details- Returns:
- content tree for the annotation type documentation header
-
getAnnotationDetails
Deprecated.Get the annotation type details tree.- Parameters:
annotationDetailsTree
- the content tree representing annotation type details- Returns:
- content tree for the annotation type details
-
getAnnotationDoc
Deprecated.Get the annotation type documentation.- Parameters:
annotationDocTree
- the content tree representing annotation type documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the annotation type documentation
-
getSignature
Deprecated.Get the signature for the given member.- Parameters:
member
- the member being documented- Returns:
- content tree for the annotation type signature
-
addDeprecated
Deprecated.Add the deprecated output for the given member.- Parameters:
member
- the member being documentedannotationDocTree
- content tree to which the deprecated information will be added
-
addComments
Deprecated.Add the comments for the given member.- Parameters:
member
- the member being documentedannotationDocTree
- the content tree to which the comments will be added
-
addTags
Deprecated.Add the tags for the given member.- Parameters:
member
- the member being documentedannotationDocTree
- the content tree to which the tags will be added
-
close
Deprecated.Close the writer.- Throws:
IOException
-