Interface ConstructorWriter
-
- All Known Implementing Classes:
ConstructorWriterImpl
@Deprecated public interface ConstructorWriter
Deprecated.The interface for writing constructor 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
- Author:
- Jamie Ho, Bhavesh Patel (Modified)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addComments(ConstructorDoc constructor, Content constructorDocTree)
Deprecated.Add the comments for the given constructor.void
addDeprecated(ConstructorDoc constructor, Content constructorDocTree)
Deprecated.Add the deprecated output for the given constructor.void
addTags(ConstructorDoc constructor, Content constructorDocTree)
Deprecated.Add the tags for the given constructor.void
close()
Deprecated.Close the writer.Content
getConstructorDetails(Content memberDetailsTree)
Deprecated.Get the constructor details tree.Content
getConstructorDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
Deprecated.Get the constructor details tree header.Content
getConstructorDoc(Content constructorDocTree, boolean isLastContent)
Deprecated.Get the constructor documentation.Content
getConstructorDocTreeHeader(ConstructorDoc constructor, Content constructorDetailsTree)
Deprecated.Get the constructor documentation tree header.Content
getSignature(ConstructorDoc constructor)
Deprecated.Get the signature for the given constructor.void
setFoundNonPubConstructor(boolean foundNonPubConstructor)
Deprecated.Let the writer know whether a non public constructor was found.
-
-
-
Method Detail
-
getConstructorDetailsTreeHeader
Content getConstructorDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
Deprecated.Get the constructor details tree header.- Parameters:
classDoc
- the class being documentedmemberDetailsTree
- the content tree representing member details- Returns:
- content tree for the constructor details header
-
getConstructorDocTreeHeader
Content getConstructorDocTreeHeader(ConstructorDoc constructor, Content constructorDetailsTree)
Deprecated.Get the constructor documentation tree header.- Parameters:
constructor
- the constructor being documentedconstructorDetailsTree
- the content tree representing constructor details- Returns:
- content tree for the constructor documentation header
-
getSignature
Content getSignature(ConstructorDoc constructor)
Deprecated.Get the signature for the given constructor.- Parameters:
constructor
- the constructor being documented- Returns:
- content tree for the constructor signature
-
addDeprecated
void addDeprecated(ConstructorDoc constructor, Content constructorDocTree)
Deprecated.Add the deprecated output for the given constructor.- Parameters:
constructor
- the constructor being documentedconstructorDocTree
- content tree to which the deprecated information will be added
-
addComments
void addComments(ConstructorDoc constructor, Content constructorDocTree)
Deprecated.Add the comments for the given constructor.- Parameters:
constructor
- the constructor being documentedconstructorDocTree
- the content tree to which the comments will be added
-
addTags
void addTags(ConstructorDoc constructor, Content constructorDocTree)
Deprecated.Add the tags for the given constructor.- Parameters:
constructor
- the constructor being documentedconstructorDocTree
- the content tree to which the tags will be added
-
getConstructorDetails
Content getConstructorDetails(Content memberDetailsTree)
Deprecated.Get the constructor details tree.- Parameters:
memberDetailsTree
- the content tree representing member details- Returns:
- content tree for the constructor details
-
getConstructorDoc
Content getConstructorDoc(Content constructorDocTree, boolean isLastContent)
Deprecated.Get the constructor documentation.- Parameters:
constructorDocTree
- the content tree representing constructor documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the constructor documentation
-
setFoundNonPubConstructor
void setFoundNonPubConstructor(boolean foundNonPubConstructor)
Deprecated.Let the writer know whether a non public constructor was found.- Parameters:
foundNonPubConstructor
- true if we found a non public constructor.
-
close
void close() throws IOException
Deprecated.Close the writer.- Throws:
IOException
-
-