Tue, 03 Dec 2013 14:21:45 -0800
8025416: doclet not substituting {@docRoot} in some cases
Reviewed-by: jjg
duke@1 | 1 | /* |
jjg@1735 | 2 | * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
bpatel@233 | 28 | import java.io.*; |
bpatel@233 | 29 | |
bpatel@233 | 30 | import com.sun.javadoc.*; |
bpatel@766 | 31 | import com.sun.tools.doclets.formats.html.markup.*; |
duke@1 | 32 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * Writes annotation type required member documentation in HTML format. |
duke@1 | 36 | * |
jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 40 | * deletion without notice.</b> |
jjg@1359 | 41 | * |
duke@1 | 42 | * @author Jamie Ho |
bpatel@243 | 43 | * @author Bhavesh Patel (Modified) |
duke@1 | 44 | */ |
duke@1 | 45 | public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter |
duke@1 | 46 | implements AnnotationTypeRequiredMemberWriter, MemberSummaryWriter { |
duke@1 | 47 | |
duke@1 | 48 | /** |
duke@1 | 49 | * Construct a new AnnotationTypeRequiredMemberWriterImpl. |
duke@1 | 50 | * |
duke@1 | 51 | * @param writer the writer that will write the output. |
duke@1 | 52 | * @param annotationType the AnnotationType that holds this member. |
duke@1 | 53 | */ |
duke@1 | 54 | public AnnotationTypeRequiredMemberWriterImpl(SubWriterHolderWriter writer, |
jjg@1410 | 55 | AnnotationTypeDoc annotationType) { |
duke@1 | 56 | super(writer, annotationType); |
duke@1 | 57 | } |
duke@1 | 58 | |
duke@1 | 59 | /** |
bpatel@766 | 60 | * {@inheritDoc} |
duke@1 | 61 | */ |
bpatel@766 | 62 | public Content getMemberSummaryHeader(ClassDoc classDoc, |
bpatel@766 | 63 | Content memberSummaryTree) { |
bpatel@766 | 64 | memberSummaryTree.addContent( |
bpatel@766 | 65 | HtmlConstants.START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY); |
bpatel@766 | 66 | Content memberTree = writer.getMemberTreeHeader(); |
bpatel@766 | 67 | writer.addSummaryHeader(this, classDoc, memberTree); |
bpatel@766 | 68 | return memberTree; |
duke@1 | 69 | } |
duke@1 | 70 | |
duke@1 | 71 | /** |
duke@1 | 72 | * {@inheritDoc} |
duke@1 | 73 | */ |
bpatel@2035 | 74 | public Content getMemberTreeHeader() { |
bpatel@2035 | 75 | return writer.getMemberTreeHeader(); |
bpatel@2035 | 76 | } |
bpatel@2035 | 77 | |
bpatel@2035 | 78 | /** |
bpatel@2035 | 79 | * {@inheritDoc} |
bpatel@2035 | 80 | */ |
bpatel@2035 | 81 | public void addAnnotationDetailsMarker(Content memberDetails) { |
bpatel@2035 | 82 | memberDetails.addContent(HtmlConstants.START_OF_ANNOTATION_TYPE_DETAILS); |
bpatel@2035 | 83 | } |
bpatel@2035 | 84 | |
bpatel@2035 | 85 | /** |
bpatel@2035 | 86 | * {@inheritDoc} |
bpatel@2035 | 87 | */ |
bpatel@766 | 88 | public void addAnnotationDetailsTreeHeader(ClassDoc classDoc, |
bpatel@766 | 89 | Content memberDetailsTree) { |
bpatel@766 | 90 | if (!writer.printedAnnotationHeading) { |
bpatel@766 | 91 | memberDetailsTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 92 | SectionName.ANNOTATION_TYPE_ELEMENT_DETAIL)); |
bpatel@766 | 93 | Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING, |
bpatel@766 | 94 | writer.annotationTypeDetailsLabel); |
bpatel@766 | 95 | memberDetailsTree.addContent(heading); |
bpatel@766 | 96 | writer.printedAnnotationHeading = true; |
bpatel@766 | 97 | } |
duke@1 | 98 | } |
duke@1 | 99 | |
duke@1 | 100 | /** |
duke@1 | 101 | * {@inheritDoc} |
duke@1 | 102 | */ |
bpatel@766 | 103 | public Content getAnnotationDocTreeHeader(MemberDoc member, |
bpatel@766 | 104 | Content annotationDetailsTree) { |
bpatel@766 | 105 | annotationDetailsTree.addContent( |
bpatel@766 | 106 | writer.getMarkerAnchor(member.name() + |
bpatel@766 | 107 | ((ExecutableMemberDoc) member).signature())); |
bpatel@766 | 108 | Content annotationDocTree = writer.getMemberTreeHeader(); |
bpatel@766 | 109 | Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING); |
bpatel@766 | 110 | heading.addContent(member.name()); |
bpatel@766 | 111 | annotationDocTree.addContent(heading); |
bpatel@766 | 112 | return annotationDocTree; |
duke@1 | 113 | } |
duke@1 | 114 | |
duke@1 | 115 | /** |
duke@1 | 116 | * {@inheritDoc} |
duke@1 | 117 | */ |
bpatel@766 | 118 | public Content getSignature(MemberDoc member) { |
bpatel@766 | 119 | Content pre = new HtmlTree(HtmlTag.PRE); |
bpatel@766 | 120 | writer.addAnnotationInfo(member, pre); |
bpatel@766 | 121 | addModifiers(member, pre); |
jjg@1736 | 122 | Content link = |
jjg@1410 | 123 | writer.getLink(new LinkInfoImpl(configuration, |
jjg@1736 | 124 | LinkInfoImpl.Kind.MEMBER, getType(member))); |
bpatel@766 | 125 | pre.addContent(link); |
bpatel@766 | 126 | pre.addContent(writer.getSpace()); |
jjg@1410 | 127 | if (configuration.linksource) { |
bpatel@766 | 128 | Content memberName = new StringContent(member.name()); |
bpatel@766 | 129 | writer.addSrcLink(member, memberName, pre); |
bpatel@766 | 130 | } else { |
bpatel@766 | 131 | addName(member.name(), pre); |
bpatel@766 | 132 | } |
bpatel@766 | 133 | return pre; |
duke@1 | 134 | } |
duke@1 | 135 | |
duke@1 | 136 | /** |
duke@1 | 137 | * {@inheritDoc} |
duke@1 | 138 | */ |
bpatel@766 | 139 | public void addDeprecated(MemberDoc member, Content annotationDocTree) { |
bpatel@766 | 140 | addDeprecatedInfo(member, annotationDocTree); |
duke@1 | 141 | } |
duke@1 | 142 | |
duke@1 | 143 | /** |
duke@1 | 144 | * {@inheritDoc} |
duke@1 | 145 | */ |
bpatel@766 | 146 | public void addComments(MemberDoc member, Content annotationDocTree) { |
bpatel@766 | 147 | addComment(member, annotationDocTree); |
duke@1 | 148 | } |
duke@1 | 149 | |
duke@1 | 150 | /** |
duke@1 | 151 | * {@inheritDoc} |
duke@1 | 152 | */ |
bpatel@766 | 153 | public void addTags(MemberDoc member, Content annotationDocTree) { |
bpatel@766 | 154 | writer.addTagsInfo(member, annotationDocTree); |
duke@1 | 155 | } |
duke@1 | 156 | |
duke@1 | 157 | /** |
duke@1 | 158 | * {@inheritDoc} |
duke@1 | 159 | */ |
bpatel@766 | 160 | public Content getAnnotationDetails(Content annotationDetailsTree) { |
bpatel@766 | 161 | return getMemberTree(annotationDetailsTree); |
duke@1 | 162 | } |
duke@1 | 163 | |
duke@1 | 164 | /** |
bpatel@766 | 165 | * {@inheritDoc} |
duke@1 | 166 | */ |
bpatel@766 | 167 | public Content getAnnotationDoc(Content annotationDocTree, |
bpatel@766 | 168 | boolean isLastContent) { |
bpatel@766 | 169 | return getMemberTree(annotationDocTree, isLastContent); |
duke@1 | 170 | } |
duke@1 | 171 | |
duke@1 | 172 | /** |
duke@1 | 173 | * Close the writer. |
duke@1 | 174 | */ |
duke@1 | 175 | public void close() throws IOException { |
duke@1 | 176 | writer.close(); |
duke@1 | 177 | } |
duke@1 | 178 | |
duke@1 | 179 | /** |
duke@1 | 180 | * {@inheritDoc} |
duke@1 | 181 | */ |
bpatel@766 | 182 | public void addSummaryLabel(Content memberTree) { |
bpatel@766 | 183 | Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, |
bpatel@766 | 184 | writer.getResource("doclet.Annotation_Type_Required_Member_Summary")); |
bpatel@766 | 185 | memberTree.addContent(label); |
bpatel@243 | 186 | } |
bpatel@243 | 187 | |
bpatel@243 | 188 | /** |
bpatel@243 | 189 | * {@inheritDoc} |
bpatel@243 | 190 | */ |
bpatel@766 | 191 | public String getTableSummary() { |
jjg@1410 | 192 | return configuration.getText("doclet.Member_Table_Summary", |
jjg@1410 | 193 | configuration.getText("doclet.Annotation_Type_Required_Member_Summary"), |
jjg@1410 | 194 | configuration.getText("doclet.annotation_type_required_members")); |
bpatel@243 | 195 | } |
bpatel@243 | 196 | |
bpatel@766 | 197 | /** |
bpatel@766 | 198 | * {@inheritDoc} |
bpatel@766 | 199 | */ |
jjg@1747 | 200 | public Content getCaption() { |
jjg@1747 | 201 | return configuration.getResource("doclet.Annotation_Type_Required_Members"); |
bpatel@766 | 202 | } |
bpatel@766 | 203 | |
bpatel@766 | 204 | /** |
bpatel@766 | 205 | * {@inheritDoc} |
bpatel@766 | 206 | */ |
bpatel@766 | 207 | public String[] getSummaryTableHeader(ProgramElementDoc member) { |
bpatel@243 | 208 | String[] header = new String[] { |
bpatel@243 | 209 | writer.getModifierTypeHeader(), |
jjg@1410 | 210 | configuration.getText("doclet.0_and_1", |
jjg@1410 | 211 | configuration.getText("doclet.Annotation_Type_Required_Member"), |
jjg@1410 | 212 | configuration.getText("doclet.Description")) |
bpatel@243 | 213 | }; |
bpatel@766 | 214 | return header; |
duke@1 | 215 | } |
duke@1 | 216 | |
duke@1 | 217 | /** |
duke@1 | 218 | * {@inheritDoc} |
duke@1 | 219 | */ |
bpatel@766 | 220 | public void addSummaryAnchor(ClassDoc cd, Content memberTree) { |
bpatel@766 | 221 | memberTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 222 | SectionName.ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY)); |
duke@1 | 223 | } |
duke@1 | 224 | |
duke@1 | 225 | /** |
duke@1 | 226 | * {@inheritDoc} |
duke@1 | 227 | */ |
bpatel@766 | 228 | public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) { |
duke@1 | 229 | } |
duke@1 | 230 | |
duke@1 | 231 | /** |
duke@1 | 232 | * {@inheritDoc} |
duke@1 | 233 | */ |
bpatel@766 | 234 | public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) { |
duke@1 | 235 | } |
duke@1 | 236 | |
duke@1 | 237 | /** |
duke@1 | 238 | * {@inheritDoc} |
duke@1 | 239 | */ |
jjg@1735 | 240 | protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member, |
bpatel@766 | 241 | Content tdSummary) { |
bpatel@2147 | 242 | Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink, |
jjg@1736 | 243 | writer.getDocLink(context, (MemberDoc) member, member.name(), false)); |
bpatel@2147 | 244 | Content code = HtmlTree.CODE(memberLink); |
bpatel@766 | 245 | tdSummary.addContent(code); |
bpatel@766 | 246 | } |
bpatel@766 | 247 | |
bpatel@766 | 248 | /** |
bpatel@766 | 249 | * {@inheritDoc} |
bpatel@766 | 250 | */ |
bpatel@766 | 251 | protected void addInheritedSummaryLink(ClassDoc cd, |
bpatel@766 | 252 | ProgramElementDoc member, Content linksTree) { |
duke@1 | 253 | //Not applicable. |
duke@1 | 254 | } |
duke@1 | 255 | |
duke@1 | 256 | /** |
duke@1 | 257 | * {@inheritDoc} |
duke@1 | 258 | */ |
bpatel@766 | 259 | protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) { |
duke@1 | 260 | MemberDoc m = (MemberDoc)member; |
bpatel@766 | 261 | addModifierAndType(m, getType(m), tdSummaryType); |
duke@1 | 262 | } |
duke@1 | 263 | |
duke@1 | 264 | /** |
duke@1 | 265 | * {@inheritDoc} |
duke@1 | 266 | */ |
bpatel@766 | 267 | protected Content getDeprecatedLink(ProgramElementDoc member) { |
jjg@1735 | 268 | return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, |
bpatel@766 | 269 | (MemberDoc) member, ((MemberDoc)member).qualifiedName()); |
duke@1 | 270 | } |
duke@1 | 271 | |
duke@1 | 272 | /** |
duke@1 | 273 | * {@inheritDoc} |
duke@1 | 274 | */ |
bpatel@766 | 275 | protected Content getNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 276 | if (link) { |
bpatel@2101 | 277 | return writer.getHyperLink( |
bpatel@2101 | 278 | SectionName.ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY, |
bpatel@766 | 279 | writer.getResource("doclet.navAnnotationTypeRequiredMember")); |
duke@1 | 280 | } else { |
bpatel@766 | 281 | return writer.getResource("doclet.navAnnotationTypeRequiredMember"); |
duke@1 | 282 | } |
duke@1 | 283 | } |
duke@1 | 284 | |
duke@1 | 285 | /** |
duke@1 | 286 | * {@inheritDoc} |
duke@1 | 287 | */ |
bpatel@766 | 288 | protected void addNavDetailLink(boolean link, Content liNav) { |
duke@1 | 289 | if (link) { |
bpatel@2101 | 290 | liNav.addContent(writer.getHyperLink( |
bpatel@2101 | 291 | SectionName.ANNOTATION_TYPE_ELEMENT_DETAIL, |
bpatel@766 | 292 | writer.getResource("doclet.navAnnotationTypeMember"))); |
duke@1 | 293 | } else { |
bpatel@766 | 294 | liNav.addContent(writer.getResource("doclet.navAnnotationTypeMember")); |
duke@1 | 295 | } |
duke@1 | 296 | } |
duke@1 | 297 | |
duke@1 | 298 | private Type getType(MemberDoc member) { |
duke@1 | 299 | if (member instanceof FieldDoc) { |
duke@1 | 300 | return ((FieldDoc) member).type(); |
duke@1 | 301 | } else { |
duke@1 | 302 | return ((MethodDoc) member).returnType(); |
duke@1 | 303 | } |
duke@1 | 304 | } |
duke@1 | 305 | } |