26 package jdk.javadoc.internal.doclets.toolkit;
  27 
  28 import javax.lang.model.element.TypeElement;
  29 import javax.lang.model.element.VariableElement;
  30 
  31 
  32 /**
  33  * The interface for writing field output.
  34  *
  35  *  <p><b>This is NOT part of any supported API.
  36  *  If you write code that depends on this, you do so at your own risk.
  37  *  This code and its internal interfaces are subject to change or
  38  *  deletion without notice.</b>
  39  */
  40 
  41 public interface FieldWriter {
  42 
  43     /**
  44      * Get the field details tree header.
  45      *
  46      * @param typeElement the class being documented
  47      * @param memberDetailsTree the content tree representing member details
  48      * @return content tree for the field details header
  49      */
  50     Content getFieldDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree);
  51 
  52     /**
  53      * Get the field documentation tree header.
  54      *
  55      * @param field the constructor being documented
  56      * @param fieldDetailsTree the content tree representing field details
  57      * @return content tree for the field documentation header
  58      */
  59     Content getFieldDocTreeHeader(VariableElement field, Content fieldDetailsTree);
  60 
  61     /**
  62      * Get the signature for the given field.
  63      *
  64      * @param field the field being documented
  65      * @return content tree for the field signature
  66      */
  67     Content getSignature(VariableElement field);
  68 
  69     /**
  70      * Add the deprecated output for the given field.
  71      *
  72      * @param field the field being documented
  73      * @param fieldDocTree content tree to which the deprecated information will be added
  74      */
  75     void addDeprecated(VariableElement field, Content fieldDocTree);
  76 
  77     /**
  78      * Add the comments for the given field.
  79      *

  26 package jdk.javadoc.internal.doclets.toolkit;
  27 
  28 import javax.lang.model.element.TypeElement;
  29 import javax.lang.model.element.VariableElement;
  30 
  31 
  32 /**
  33  * The interface for writing field output.
  34  *
  35  *  <p><b>This is NOT part of any supported API.
  36  *  If you write code that depends on this, you do so at your own risk.
  37  *  This code and its internal interfaces are subject to change or
  38  *  deletion without notice.</b>
  39  */
  40 
  41 public interface FieldWriter {
  42 
  43     /**
  44      * Get the field details tree header.
  45      *

  46      * @param memberDetailsTree the content tree representing member details
  47      * @return content tree for the field details header
  48      */
  49     Content getFieldDetailsTreeHeader(Content memberDetailsTree);
  50 
  51     /**
  52      * Get the field documentation tree header.
  53      *
  54      * @param field the constructor being documented

  55      * @return content tree for the field documentation header
  56      */
  57     Content getFieldDocTreeHeader(VariableElement field);
  58 
  59     /**
  60      * Get the signature for the given field.
  61      *
  62      * @param field the field being documented
  63      * @return content tree for the field signature
  64      */
  65     Content getSignature(VariableElement field);
  66 
  67     /**
  68      * Add the deprecated output for the given field.
  69      *
  70      * @param field the field being documented
  71      * @param fieldDocTree content tree to which the deprecated information will be added
  72      */
  73     void addDeprecated(VariableElement field, Content fieldDocTree);
  74 
  75     /**
  76      * Add the comments for the given field.
  77      *