Interface PropertyWriter
- All Known Implementing Classes:
PropertyWriterImpl
Deprecated.
The interface for writing property 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.7
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addComments
(MethodDoc property, Content propertyDocTree) Deprecated.Add the comments for the given property.void
addDeprecated
(MethodDoc property, Content propertyDocTree) Deprecated.Add the deprecated output for the given property.void
Deprecated.Add the tags for the given property.void
close()
Deprecated.Close the writer.getPropertyDetails
(Content memberDetailsTree) Deprecated.Get the property details tree.getPropertyDetailsTreeHeader
(ClassDoc classDoc, Content memberDetailsTree) Deprecated.Get the property details tree header.getPropertyDoc
(Content propertyDocTree, boolean isLastContent) Deprecated.Get the property documentation.getPropertyDocTreeHeader
(MethodDoc property, Content propertyDetailsTree) Deprecated.Get the property documentation tree header.getSignature
(MethodDoc property) Deprecated.Get the signature for the given property.
-
Method Details
-
getPropertyDetailsTreeHeader
Deprecated.Get the property details tree header.- Parameters:
classDoc
- the class being documentedmemberDetailsTree
- the content tree representing member details- Returns:
- content tree for the property details header
-
getPropertyDocTreeHeader
Deprecated.Get the property documentation tree header.- Parameters:
property
- the property being documentedpropertyDetailsTree
- the content tree representing property details- Returns:
- content tree for the property documentation header
-
getSignature
Deprecated.Get the signature for the given property.- Parameters:
property
- the property being documented- Returns:
- content tree for the property signature
-
addDeprecated
Deprecated.Add the deprecated output for the given property.- Parameters:
property
- the property being documentedpropertyDocTree
- content tree to which the deprecated information will be added
-
addComments
Deprecated.Add the comments for the given property.- Parameters:
property
- the property being documentedpropertyDocTree
- the content tree to which the comments will be added
-
addTags
Deprecated.Add the tags for the given property.- Parameters:
property
- the property being documentedpropertyDocTree
- the content tree to which the tags will be added
-
getPropertyDetails
Deprecated.Get the property details tree.- Parameters:
memberDetailsTree
- the content tree representing member details- Returns:
- content tree for the property details
-
getPropertyDoc
Deprecated.Get the property documentation.- Parameters:
propertyDocTree
- the content tree representing property documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the property documentation
-
close
Deprecated.Close the writer.- Throws:
IOException
-