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

Schnittstelle ConstructorWriter

Alle Superschnittstellen:
MemberWriter
Alle bekannten Implementierungsklassen:
ConstructorWriterImpl
public interface ConstructorWriter extends MemberWriter
The interface for writing constructor output.

  • Methodendetails

    • getConstructorDetailsHeader

      Content getConstructorDetailsHeader(Content content)
      Gibt the constructor details header zurück.
      Parameter:
      content - the content representing member details
      Gibt zurück:
      the constructor details header

    • getConstructorHeaderContent

      Content getConstructorHeaderContent(ExecutableElement constructor)
      Gibt the constructor documentation header zurück.
      Parameter:
      constructor - the constructor being documented
      Gibt zurück:
      the constructor documentation header

    • getSignature

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

    • addDeprecated

      void addDeprecated(ExecutableElement constructor, Content constructorContent)
      Add the deprecated output for the given constructor.
      Parameter:
      constructor - the constructor being documented
      constructorContent - the 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 constructor, Content constructorContent)
      Add the comments for the given constructor.
      Parameter:
      constructor - the constructor being documented
      constructorContent - the content to which the comments will be added

    • addTags

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

    • getConstructorDetails

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

    • setFoundNonPubConstructor

      void setFoundNonPubConstructor(boolean foundNonPubConstructor)
      Let the writer know whether a non public constructor was found.
      Parameter:
      foundNonPubConstructor - true if we found a non public constructor.

    • getMemberHeader

      Content getMemberHeader()
      Gibt zurück:
      the member header}