Interface EnumConstantWriter

  • All Known Implementing Classes:
    EnumConstantWriterImpl

    @Deprecated
    public interface EnumConstantWriter
    Deprecated.
    The interface for writing enum constant 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 Detail

      • getEnumConstantsDetailsTreeHeader

        Content getEnumConstantsDetailsTreeHeader​(ClassDoc classDoc,
                                                  Content memberDetailsTree)
        Deprecated.
        Get the enum constants details tree header.
        Parameters:
        classDoc - the class being documented
        memberDetailsTree - the content tree representing member details
        Returns:
        content tree for the enum constants details header
      • getEnumConstantsTreeHeader

        Content getEnumConstantsTreeHeader​(FieldDoc enumConstant,
                                           Content enumConstantsDetailsTree)
        Deprecated.
        Get the enum constants documentation tree header.
        Parameters:
        enumConstant - the enum constant being documented
        enumConstantsDetailsTree - the content tree representing enum constant details
        Returns:
        content tree for the enum constant documentation header
      • getSignature

        Content getSignature​(FieldDoc enumConstant)
        Deprecated.
        Get the signature for the given enum constant.
        Parameters:
        enumConstant - the enum constant being documented
        Returns:
        content tree for the enum constant signature
      • addDeprecated

        void addDeprecated​(FieldDoc enumConstant,
                           Content enumConstantsTree)
        Deprecated.
        Add the deprecated output for the given enum constant.
        Parameters:
        enumConstant - the enum constant being documented
        enumConstantsTree - content tree to which the deprecated information will be added
      • addComments

        void addComments​(FieldDoc enumConstant,
                         Content enumConstantsTree)
        Deprecated.
        Add the comments for the given enum constant.
        Parameters:
        enumConstant - the enum constant being documented
        enumConstantsTree - the content tree to which the comments will be added
      • addTags

        void addTags​(FieldDoc enumConstant,
                     Content enumConstantsTree)
        Deprecated.
        Add the tags for the given enum constant.
        Parameters:
        enumConstant - the enum constant being documented
        enumConstantsTree - the content tree to which the tags will be added
      • getEnumConstantsDetails

        Content getEnumConstantsDetails​(Content memberDetailsTree)
        Deprecated.
        Get the enum constants details tree.
        Parameters:
        memberDetailsTree - the content tree representing member details
        Returns:
        content tree for the enum constant details
      • getEnumConstants

        Content getEnumConstants​(Content enumConstantsTree,
                                 boolean isLastContent)
        Deprecated.
        Get the enum constants documentation.
        Parameters:
        enumConstantsTree - the content tree representing enum constants documentation
        isLastContent - true if the content to be added is the last content
        Returns:
        content tree for the enum constants documentation