< prev index next >

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/FieldWriterImpl.java

Print this page




  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.formats.html;
  27 
  28 import java.util.Arrays;
  29 import java.util.List;
  30 
  31 import javax.lang.model.element.Element;
  32 import javax.lang.model.element.TypeElement;
  33 import javax.lang.model.element.VariableElement;
  34 
  35 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
  36 import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
  37 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
  38 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
  39 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
  40 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
  41 import jdk.javadoc.internal.doclets.formats.html.markup.Table;
  42 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
  43 import jdk.javadoc.internal.doclets.toolkit.Content;
  44 import jdk.javadoc.internal.doclets.toolkit.FieldWriter;
  45 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
  46 
  47 /**
  48  * Writes field documentation in HTML format.
  49  *
  50  *  <p><b>This is NOT part of any supported API.
  51  *  If you write code that depends on this, you do so at your own risk.
  52  *  This code and its internal interfaces are subject to change or
  53  *  deletion without notice.</b>
  54  *
  55  * @author Robert Field
  56  * @author Atul M Dambalkar
  57  * @author Jamie Ho (rewrite)
  58  * @author Bhavesh Patel (Modified)


 104     }
 105 
 106     /**
 107      * {@inheritDoc}
 108      */
 109     @Override
 110     public Content getFieldDocTreeHeader(VariableElement field, Content fieldDetailsTree) {
 111         Content fieldTree = new ContentBuilder();
 112         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 113         heading.add(name(field));
 114         fieldTree.add(heading);
 115         fieldTree.add(links.createAnchor(name(field)));
 116         return HtmlTree.SECTION(HtmlStyle.detail, fieldTree);
 117     }
 118 
 119     /**
 120      * {@inheritDoc}
 121      */
 122     @Override
 123     public Content getSignature(VariableElement field) {
 124         Content pre = new HtmlTree(HtmlTag.PRE);
 125         writer.addAnnotationInfo(field, pre);
 126         addModifiers(field, pre);
 127         Content fieldlink = writer.getLink(new LinkInfoImpl(
 128                 configuration, LinkInfoImpl.Kind.MEMBER, field.asType()));
 129         pre.add(fieldlink);
 130         pre.add(" ");
 131         if (configuration.linksource) {
 132             Content fieldName = new StringContent(name(field));
 133             writer.addSrcLink(field, fieldName, pre);
 134         } else {
 135             addName(name(field), pre);
 136         }
 137         return pre;
 138     }
 139 
 140     /**
 141      * {@inheritDoc}
 142      */
 143     @Override
 144     public void addDeprecated(VariableElement field, Content fieldTree) {
 145         addDeprecatedInfo(field, fieldTree);
 146     }
 147 
 148     /**
 149      * {@inheritDoc}
 150      */
 151     @Override
 152     public void addComments(VariableElement field, Content fieldTree) {
 153         if (!utils.getFullBody(field).isEmpty()) {
 154             writer.addInlineComment(field, fieldTree);
 155         }
 156     }
 157 




  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.formats.html;
  27 
  28 import java.util.Arrays;
  29 import java.util.List;
  30 
  31 import javax.lang.model.element.Element;
  32 import javax.lang.model.element.TypeElement;
  33 import javax.lang.model.element.VariableElement;
  34 
  35 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
  36 import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
  37 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;

  38 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
  39 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
  40 import jdk.javadoc.internal.doclets.formats.html.markup.Table;
  41 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
  42 import jdk.javadoc.internal.doclets.toolkit.Content;
  43 import jdk.javadoc.internal.doclets.toolkit.FieldWriter;
  44 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
  45 
  46 /**
  47  * Writes field documentation in HTML format.
  48  *
  49  *  <p><b>This is NOT part of any supported API.
  50  *  If you write code that depends on this, you do so at your own risk.
  51  *  This code and its internal interfaces are subject to change or
  52  *  deletion without notice.</b>
  53  *
  54  * @author Robert Field
  55  * @author Atul M Dambalkar
  56  * @author Jamie Ho (rewrite)
  57  * @author Bhavesh Patel (Modified)


 103     }
 104 
 105     /**
 106      * {@inheritDoc}
 107      */
 108     @Override
 109     public Content getFieldDocTreeHeader(VariableElement field, Content fieldDetailsTree) {
 110         Content fieldTree = new ContentBuilder();
 111         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 112         heading.add(name(field));
 113         fieldTree.add(heading);
 114         fieldTree.add(links.createAnchor(name(field)));
 115         return HtmlTree.SECTION(HtmlStyle.detail, fieldTree);
 116     }
 117 
 118     /**
 119      * {@inheritDoc}
 120      */
 121     @Override
 122     public Content getSignature(VariableElement field) {
 123         MemberSignature sig = new MemberSignature(field);
 124         sig.addType(field.asType());
 125         sig.addName(field);
 126         return sig.toContent();










 127     }
 128 
 129     /**
 130      * {@inheritDoc}
 131      */
 132     @Override
 133     public void addDeprecated(VariableElement field, Content fieldTree) {
 134         addDeprecatedInfo(field, fieldTree);
 135     }
 136 
 137     /**
 138      * {@inheritDoc}
 139      */
 140     @Override
 141     public void addComments(VariableElement field, Content fieldTree) {
 142         if (!utils.getFullBody(field).isEmpty()) {
 143             writer.addInlineComment(field, fieldTree);
 144         }
 145     }
 146 


< prev index next >