Package org.jdrupes.mdoclet.internal.doclets.toolkit

Schnittstelle PropertyWriter

Alle Superschnittstellen:
MemberWriter
Alle bekannten Implementierungsklassen:
PropertyWriterImpl
public interface PropertyWriter extends MemberWriter
The interface for writing property output.

  • Methodendetails

    • getPropertyDetailsHeader

      Content getPropertyDetailsHeader(Content memberDetails)
      Get the property details header.
      Parameter:
      memberDetails - the content representing member details
      Gibt zurück:
      the property details header

    • getPropertyHeaderContent

      Content getPropertyHeaderContent(ExecutableElement property)
      Get the property documentation header.
      Parameter:
      property - the property being documented
      Gibt zurück:
      the property documentation header

    • getSignature

      Content getSignature(ExecutableElement property)
      Get the signature for the given property.
      Parameter:
      property - the property being documented
      Gibt zurück:
      the property signature

    • addDeprecated

      void addDeprecated(ExecutableElement property, Content propertyContent)
      Add the deprecated output for the given property.
      Parameter:
      property - the property being documented
      propertyContent - content to which the deprecated information will be added

    • addPreview

      void addPreview(ExecutableElement member, Content content)
      Add the preview output for the given member.
      Parameter:
      member - the member being documented
      content - the content to which the preview information will be added

    • addComments

      void addComments(ExecutableElement property, Content propertyContent)
      Add the comments for the given property.
      Parameter:
      property - the property being documented
      propertyContent - the content to which the comments will be added

    • addTags

      void addTags(ExecutableElement property, Content propertyContent)
      Add the tags for the given property.
      Parameter:
      property - the property being documented
      propertyContent - the content to which the tags will be added

    • getPropertyDetails

      Content getPropertyDetails(Content memberDetailsHeader, Content memberDetails)
      Get the property details.
      Parameter:
      memberDetailsHeader - the content representing member details header
      memberDetails - the content representing member details
      Gibt zurück:
      the property details