< prev index next >

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

Print this page




  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  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 javax.lang.model.element.Element;
  29 import javax.lang.model.element.ExecutableElement;
  30 import javax.lang.model.element.TypeElement;
  31 
  32 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
  33 import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
  34 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
  35 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
  36 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
  37 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
  38 import jdk.javadoc.internal.doclets.formats.html.markup.Table;
  39 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
  40 import jdk.javadoc.internal.doclets.toolkit.Content;
  41 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
  42 import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
  43 
  44 /**
  45  * Writes property documentation in HTML format.
  46  *
  47  *  <p><b>This is NOT part of any supported API.
  48  *  If you write code that depends on this, you do so at your own risk.
  49  *  This code and its internal interfaces are subject to change or
  50  *  deletion without notice.</b>
  51  *
  52  * @author Robert Field
  53  * @author Atul M Dambalkar
  54  * @author Jamie Ho (rewrite)
  55  * @author Bhavesh Patel (Modified)


  97 
  98     /**
  99      * {@inheritDoc}
 100      */
 101     @Override
 102     public Content getPropertyDocTreeHeader(ExecutableElement property,
 103             Content propertyDetailsTree) {
 104         Content propertyDocTree = new ContentBuilder();
 105         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 106         heading.add(utils.getPropertyLabel(name(property)));
 107         propertyDocTree.add(heading);
 108         propertyDocTree.add(links.createAnchor(name(property)));
 109         return HtmlTree.SECTION(HtmlStyle.detail, propertyDocTree);
 110     }
 111 
 112     /**
 113      * {@inheritDoc}
 114      */
 115     @Override
 116     public Content getSignature(ExecutableElement property) {
 117         Content pre = new HtmlTree(HtmlTag.PRE);
 118         writer.addAnnotationInfo(property, pre);
 119         addModifiers(property, pre);
 120         Content propertylink = writer.getLink(new LinkInfoImpl(
 121                 configuration, LinkInfoImpl.Kind.MEMBER,
 122                 utils.getReturnType(property)));
 123         pre.add(propertylink);
 124         pre.add(" ");
 125         if (configuration.linksource) {
 126             Content propertyName = new StringContent(name(property));
 127             writer.addSrcLink(property, propertyName, pre);
 128         } else {
 129             addName(name(property), pre);
 130         }
 131         return pre;
 132     }
 133 
 134     /**
 135      * {@inheritDoc}
 136      */
 137     @Override
 138     public void addDeprecated(ExecutableElement property, Content propertyDocTree) {
 139     }
 140 
 141     /**
 142      * {@inheritDoc}
 143      */
 144     @Override
 145     public void addComments(ExecutableElement property, Content propertyDocTree) {
 146         TypeElement holder = (TypeElement)property.getEnclosingElement();
 147         if (!utils.getFullBody(property).isEmpty()) {
 148             if (holder.equals(typeElement) ||
 149                     (!utils.isPublic(holder) || utils.isLinkable(holder))) {
 150                 writer.addInlineComment(property, propertyDocTree);
 151             } else {




  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  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 javax.lang.model.element.Element;
  29 import javax.lang.model.element.ExecutableElement;
  30 import javax.lang.model.element.TypeElement;
  31 
  32 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
  33 import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
  34 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;

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


  96 
  97     /**
  98      * {@inheritDoc}
  99      */
 100     @Override
 101     public Content getPropertyDocTreeHeader(ExecutableElement property,
 102             Content propertyDetailsTree) {
 103         Content propertyDocTree = new ContentBuilder();
 104         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 105         heading.add(utils.getPropertyLabel(name(property)));
 106         propertyDocTree.add(heading);
 107         propertyDocTree.add(links.createAnchor(name(property)));
 108         return HtmlTree.SECTION(HtmlStyle.detail, propertyDocTree);
 109     }
 110 
 111     /**
 112      * {@inheritDoc}
 113      */
 114     @Override
 115     public Content getSignature(ExecutableElement property) {
 116         return new MemberSignature(property)
 117                 .addType(utils.getReturnType(property))
 118                 .toContent();












 119     }
 120 
 121     /**
 122      * {@inheritDoc}
 123      */
 124     @Override
 125     public void addDeprecated(ExecutableElement property, Content propertyDocTree) {
 126     }
 127 
 128     /**
 129      * {@inheritDoc}
 130      */
 131     @Override
 132     public void addComments(ExecutableElement property, Content propertyDocTree) {
 133         TypeElement holder = (TypeElement)property.getEnclosingElement();
 134         if (!utils.getFullBody(property).isEmpty()) {
 135             if (holder.equals(typeElement) ||
 136                     (!utils.isPublic(holder) || utils.isLinkable(holder))) {
 137                 writer.addInlineComment(property, propertyDocTree);
 138             } else {


< prev index next >