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

Schnittstelle AnnotationTypeMemberWriter

Alle Superschnittstellen:
MemberWriter
Alle bekannten Implementierungsklassen:
AnnotationTypeMemberWriterImpl
public interface AnnotationTypeMemberWriter extends MemberWriter
The interface for writing annotation type required member output.

  • Methodendetails

    • getMemberHeader

      Content getMemberHeader()
      Adds the annotation type member header.
      Gibt zurück:
      the content for the member header

    • addAnnotationDetailsMarker

      void addAnnotationDetailsMarker(Content memberDetails)
      Adds the annotation type details marker.
      Parameter:
      memberDetails - the content representing details marker

    • getAnnotationDetailsHeader

      Content getAnnotationDetailsHeader()
      Adds the annotation type details header.
      Gibt zurück:
      the content for the annotation details header

    • getAnnotationHeaderContent

      Content getAnnotationHeaderContent(Element member)
      Gets the annotation type documentation header.
      Parameter:
      member - the annotation type being documented
      Gibt zurück:
      the content for the annotation type documentation header

    • getAnnotationDetails

      Content getAnnotationDetails(Content annotationDetailsHeader, Content annotationDetails)
      Gets the annotation type details.
      Parameter:
      annotationDetailsHeader - the content representing annotation type details header
      annotationDetails - the content representing annotation type details
      Gibt zurück:
      the annotation type details

    • getSignature

      Content getSignature(Element member)
      Gibt the signature for the specified member zurück.
      Parameter:
      member - the member being documented
      Gibt zurück:
      the signature for the specified member

    • addDeprecated

      void addDeprecated(Element member, Content target)
      Adds the deprecated output for the given member.
      Parameter:
      member - the member being documented
      target - the content to which the deprecated information will be added

    • addPreview

      void addPreview(Element member, Content content)
      Adds 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(Element member, Content annotationContent)
      Adds the comments for the given member.
      Parameter:
      member - the member being documented
      annotationContent - the content to which the comments will be added

    • addTags

      void addTags(Element member, Content annotationContent)
      Adds the tags for the given member.
      Parameter:
      member - the member being documented
      annotationContent - the content to which the tags will be added

    • addDefaultValueInfo

      void addDefaultValueInfo(Element member, Content annotationContent)
      Adds the default value documentation if the member has one.
      Parameter:
      member - the member being documented
      annotationContent - the content to which the default value will be added