Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit

Interface FieldWriter

  • All Known Implementing Classes:
    FieldWriterImpl, HtmlSerialFieldWriter
    @Deprecated
public interface FieldWriter
    Deprecated.
    The interface for writing field 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

      • getFieldDetailsTreeHeader

        Content getFieldDetailsTreeHeader​(ClassDoc classDoc,
                                  Content memberDetailsTree)
        Deprecated.
        Get the field details tree header.
        Parameters:
        classDoc - the class being documented
        memberDetailsTree - the content tree representing member details
        Returns:
        content tree for the field details header

      • getFieldDocTreeHeader

        Content getFieldDocTreeHeader​(FieldDoc field,
                              Content fieldDetailsTree)
        Deprecated.
        Get the field documentation tree header.
        Parameters:
        field - the constructor being documented
        fieldDetailsTree - the content tree representing field details
        Returns:
        content tree for the field documentation header

      • getSignature

        Content getSignature​(FieldDoc field)
        Deprecated.
        Get the signature for the given field.
        Parameters:
        field - the field being documented
        Returns:
        content tree for the field signature

      • addDeprecated

        void addDeprecated​(FieldDoc field,
                   Content fieldDocTree)
        Deprecated.
        Add the deprecated output for the given field.
        Parameters:
        field - the field being documented
        fieldDocTree - content tree to which the deprecated information will be added

      • addComments

        void addComments​(FieldDoc field,
                 Content fieldDocTree)
        Deprecated.
        Add the comments for the given field.
        Parameters:
        field - the field being documented
        fieldDocTree - the content tree to which the comments will be added

      • addTags

        void addTags​(FieldDoc field,
             Content fieldDocTree)
        Deprecated.
        Add the tags for the given field.
        Parameters:
        field - the field being documented
        fieldDocTree - the content tree to which the tags will be added

      • getFieldDetails

        Content getFieldDetails​(Content memberDetailsTree)
        Deprecated.
        Get the field details tree.
        Parameters:
        memberDetailsTree - the content tree representing member details
        Returns:
        content tree for the field details

      • getFieldDoc

        Content getFieldDoc​(Content fieldDocTree,
                    boolean isLastContent)
        Deprecated.
        Get the field documentation.
        Parameters:
        fieldDocTree - the content tree representing field documentation
        isLastContent - true if the content to be added is the last content
        Returns:
        content tree for the field documentation