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 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 34 | |
duke@1 | 35 | /** |
duke@1 | 36 | * Writes enum constant documentation in HTML format. |
duke@1 | 37 | * |
jjg@1359 | 38 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 39 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 40 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 41 | * deletion without notice.</b> |
jjg@1359 | 42 | * |
duke@1 | 43 | * @author Jamie Ho |
bpatel@243 | 44 | * @author Bhavesh Patel (Modified) |
duke@1 | 45 | */ |
duke@1 | 46 | public class EnumConstantWriterImpl extends AbstractMemberWriter |
duke@1 | 47 | implements EnumConstantWriter, MemberSummaryWriter { |
duke@1 | 48 | |
duke@1 | 49 | public EnumConstantWriterImpl(SubWriterHolderWriter writer, |
duke@1 | 50 | ClassDoc classdoc) { |
duke@1 | 51 | super(writer, classdoc); |
duke@1 | 52 | } |
duke@1 | 53 | |
duke@1 | 54 | public EnumConstantWriterImpl(SubWriterHolderWriter writer) { |
duke@1 | 55 | super(writer); |
duke@1 | 56 | } |
duke@1 | 57 | |
duke@1 | 58 | /** |
bpatel@766 | 59 | * {@inheritDoc} |
duke@1 | 60 | */ |
bpatel@766 | 61 | public Content getMemberSummaryHeader(ClassDoc classDoc, |
bpatel@766 | 62 | Content memberSummaryTree) { |
bpatel@766 | 63 | memberSummaryTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_SUMMARY); |
bpatel@766 | 64 | Content memberTree = writer.getMemberTreeHeader(); |
bpatel@766 | 65 | writer.addSummaryHeader(this, classDoc, memberTree); |
bpatel@766 | 66 | return memberTree; |
duke@1 | 67 | } |
duke@1 | 68 | |
duke@1 | 69 | /** |
duke@1 | 70 | * {@inheritDoc} |
duke@1 | 71 | */ |
bpatel@766 | 72 | public Content getEnumConstantsDetailsTreeHeader(ClassDoc classDoc, |
bpatel@766 | 73 | Content memberDetailsTree) { |
bpatel@766 | 74 | memberDetailsTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_DETAILS); |
bpatel@766 | 75 | Content enumConstantsDetailsTree = writer.getMemberTreeHeader(); |
bpatel@2101 | 76 | enumConstantsDetailsTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 77 | SectionName.ENUM_CONSTANT_DETAIL)); |
bpatel@766 | 78 | Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING, |
bpatel@766 | 79 | writer.enumConstantsDetailsLabel); |
bpatel@766 | 80 | enumConstantsDetailsTree.addContent(heading); |
bpatel@766 | 81 | return enumConstantsDetailsTree; |
duke@1 | 82 | } |
duke@1 | 83 | |
duke@1 | 84 | /** |
duke@1 | 85 | * {@inheritDoc} |
duke@1 | 86 | */ |
bpatel@766 | 87 | public Content getEnumConstantsTreeHeader(FieldDoc enumConstant, |
bpatel@766 | 88 | Content enumConstantsDetailsTree) { |
bpatel@766 | 89 | enumConstantsDetailsTree.addContent( |
bpatel@766 | 90 | writer.getMarkerAnchor(enumConstant.name())); |
bpatel@766 | 91 | Content enumConstantsTree = writer.getMemberTreeHeader(); |
bpatel@766 | 92 | Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING); |
bpatel@766 | 93 | heading.addContent(enumConstant.name()); |
bpatel@766 | 94 | enumConstantsTree.addContent(heading); |
bpatel@766 | 95 | return enumConstantsTree; |
duke@1 | 96 | } |
duke@1 | 97 | |
duke@1 | 98 | /** |
duke@1 | 99 | * {@inheritDoc} |
duke@1 | 100 | */ |
bpatel@766 | 101 | public Content getSignature(FieldDoc enumConstant) { |
bpatel@766 | 102 | Content pre = new HtmlTree(HtmlTag.PRE); |
bpatel@766 | 103 | writer.addAnnotationInfo(enumConstant, pre); |
bpatel@766 | 104 | addModifiers(enumConstant, pre); |
jjg@1736 | 105 | Content enumConstantLink = writer.getLink(new LinkInfoImpl( |
jjg@1736 | 106 | configuration, LinkInfoImpl.Kind.MEMBER, enumConstant.type())); |
bpatel@766 | 107 | pre.addContent(enumConstantLink); |
bpatel@766 | 108 | pre.addContent(" "); |
jjg@1410 | 109 | if (configuration.linksource) { |
bpatel@766 | 110 | Content enumConstantName = new StringContent(enumConstant.name()); |
bpatel@766 | 111 | writer.addSrcLink(enumConstant, enumConstantName, pre); |
bpatel@766 | 112 | } else { |
bpatel@766 | 113 | addName(enumConstant.name(), pre); |
duke@1 | 114 | } |
bpatel@766 | 115 | return pre; |
duke@1 | 116 | } |
duke@1 | 117 | |
duke@1 | 118 | /** |
duke@1 | 119 | * {@inheritDoc} |
duke@1 | 120 | */ |
bpatel@766 | 121 | public void addDeprecated(FieldDoc enumConstant, Content enumConstantsTree) { |
bpatel@766 | 122 | addDeprecatedInfo(enumConstant, enumConstantsTree); |
duke@1 | 123 | } |
duke@1 | 124 | |
duke@1 | 125 | /** |
duke@1 | 126 | * {@inheritDoc} |
duke@1 | 127 | */ |
bpatel@766 | 128 | public void addComments(FieldDoc enumConstant, Content enumConstantsTree) { |
bpatel@766 | 129 | addComment(enumConstant, enumConstantsTree); |
duke@1 | 130 | } |
duke@1 | 131 | |
duke@1 | 132 | /** |
duke@1 | 133 | * {@inheritDoc} |
duke@1 | 134 | */ |
bpatel@766 | 135 | public void addTags(FieldDoc enumConstant, Content enumConstantsTree) { |
bpatel@766 | 136 | writer.addTagsInfo(enumConstant, enumConstantsTree); |
duke@1 | 137 | } |
duke@1 | 138 | |
duke@1 | 139 | /** |
duke@1 | 140 | * {@inheritDoc} |
duke@1 | 141 | */ |
bpatel@766 | 142 | public Content getEnumConstantsDetails(Content enumConstantsDetailsTree) { |
bpatel@766 | 143 | return getMemberTree(enumConstantsDetailsTree); |
duke@1 | 144 | } |
duke@1 | 145 | |
duke@1 | 146 | /** |
duke@1 | 147 | * {@inheritDoc} |
duke@1 | 148 | */ |
bpatel@766 | 149 | public Content getEnumConstants(Content enumConstantsTree, |
bpatel@766 | 150 | boolean isLastContent) { |
bpatel@766 | 151 | return getMemberTree(enumConstantsTree, isLastContent); |
duke@1 | 152 | } |
duke@1 | 153 | |
duke@1 | 154 | /** |
duke@1 | 155 | * {@inheritDoc} |
duke@1 | 156 | */ |
duke@1 | 157 | public void close() throws IOException { |
duke@1 | 158 | writer.close(); |
duke@1 | 159 | } |
duke@1 | 160 | |
duke@1 | 161 | public int getMemberKind() { |
duke@1 | 162 | return VisibleMemberMap.ENUM_CONSTANTS; |
duke@1 | 163 | } |
duke@1 | 164 | |
bpatel@766 | 165 | /** |
bpatel@766 | 166 | * {@inheritDoc} |
bpatel@766 | 167 | */ |
bpatel@766 | 168 | public void addSummaryLabel(Content memberTree) { |
bpatel@766 | 169 | Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, |
bpatel@766 | 170 | writer.getResource("doclet.Enum_Constant_Summary")); |
bpatel@766 | 171 | memberTree.addContent(label); |
bpatel@243 | 172 | } |
bpatel@243 | 173 | |
bpatel@766 | 174 | /** |
bpatel@766 | 175 | * {@inheritDoc} |
bpatel@766 | 176 | */ |
bpatel@766 | 177 | public String getTableSummary() { |
jjg@1410 | 178 | return configuration.getText("doclet.Member_Table_Summary", |
jjg@1410 | 179 | configuration.getText("doclet.Enum_Constant_Summary"), |
jjg@1410 | 180 | configuration.getText("doclet.enum_constants")); |
bpatel@243 | 181 | } |
bpatel@243 | 182 | |
bpatel@766 | 183 | /** |
bpatel@766 | 184 | * {@inheritDoc} |
bpatel@766 | 185 | */ |
jjg@1747 | 186 | public Content getCaption() { |
jjg@1747 | 187 | return configuration.getResource("doclet.Enum_Constants"); |
bpatel@766 | 188 | } |
bpatel@766 | 189 | |
bpatel@766 | 190 | /** |
bpatel@766 | 191 | * {@inheritDoc} |
bpatel@766 | 192 | */ |
bpatel@766 | 193 | public String[] getSummaryTableHeader(ProgramElementDoc member) { |
bpatel@243 | 194 | String[] header = new String[] { |
jjg@1410 | 195 | configuration.getText("doclet.0_and_1", |
jjg@1410 | 196 | configuration.getText("doclet.Enum_Constant"), |
jjg@1410 | 197 | configuration.getText("doclet.Description")) |
bpatel@243 | 198 | }; |
bpatel@766 | 199 | return header; |
duke@1 | 200 | } |
duke@1 | 201 | |
bpatel@766 | 202 | /** |
bpatel@766 | 203 | * {@inheritDoc} |
bpatel@766 | 204 | */ |
bpatel@766 | 205 | public void addSummaryAnchor(ClassDoc cd, Content memberTree) { |
bpatel@2101 | 206 | memberTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 207 | SectionName.ENUM_CONSTANT_SUMMARY)); |
duke@1 | 208 | } |
duke@1 | 209 | |
bpatel@766 | 210 | /** |
bpatel@766 | 211 | * {@inheritDoc} |
bpatel@766 | 212 | */ |
bpatel@766 | 213 | public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) { |
duke@1 | 214 | } |
duke@1 | 215 | |
bpatel@766 | 216 | /** |
bpatel@766 | 217 | * {@inheritDoc} |
bpatel@766 | 218 | */ |
bpatel@766 | 219 | public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) { |
duke@1 | 220 | } |
duke@1 | 221 | |
bpatel@766 | 222 | /** |
bpatel@766 | 223 | * {@inheritDoc} |
bpatel@766 | 224 | */ |
jjg@1735 | 225 | protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member, |
bpatel@766 | 226 | Content tdSummary) { |
bpatel@2147 | 227 | Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink, |
jjg@1736 | 228 | writer.getDocLink(context, (MemberDoc) member, member.name(), false)); |
bpatel@2147 | 229 | Content code = HtmlTree.CODE(memberLink); |
bpatel@766 | 230 | tdSummary.addContent(code); |
duke@1 | 231 | } |
duke@1 | 232 | |
bpatel@766 | 233 | /** |
bpatel@766 | 234 | * {@inheritDoc} |
bpatel@766 | 235 | */ |
bpatel@766 | 236 | @Override |
bpatel@766 | 237 | public void setSummaryColumnStyle(HtmlTree tdTree) { |
bpatel@766 | 238 | tdTree.addStyle(HtmlStyle.colOne); |
bpatel@766 | 239 | } |
bpatel@766 | 240 | |
bpatel@766 | 241 | /** |
bpatel@766 | 242 | * {@inheritDoc} |
bpatel@766 | 243 | */ |
bpatel@766 | 244 | protected void addInheritedSummaryLink(ClassDoc cd, |
bpatel@766 | 245 | ProgramElementDoc member, Content linksTree) { |
bpatel@766 | 246 | } |
bpatel@766 | 247 | |
bpatel@766 | 248 | /** |
bpatel@766 | 249 | * {@inheritDoc} |
bpatel@766 | 250 | */ |
bpatel@766 | 251 | protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) { |
duke@1 | 252 | //Not applicable. |
duke@1 | 253 | } |
duke@1 | 254 | |
bpatel@766 | 255 | /** |
bpatel@766 | 256 | * {@inheritDoc} |
bpatel@766 | 257 | */ |
bpatel@766 | 258 | protected Content getDeprecatedLink(ProgramElementDoc member) { |
jjg@1735 | 259 | return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, |
bpatel@766 | 260 | (MemberDoc) member, ((FieldDoc)member).qualifiedName()); |
duke@1 | 261 | } |
duke@1 | 262 | |
bpatel@766 | 263 | /** |
bpatel@766 | 264 | * {@inheritDoc} |
bpatel@766 | 265 | */ |
bpatel@766 | 266 | protected Content getNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 267 | if (link) { |
bpatel@2101 | 268 | if (cd == null) { |
bpatel@2101 | 269 | return writer.getHyperLink(SectionName.ENUM_CONSTANT_SUMMARY, |
bpatel@2101 | 270 | writer.getResource("doclet.navEnum")); |
bpatel@2101 | 271 | } else { |
bpatel@2101 | 272 | return writer.getHyperLink( |
bpatel@2101 | 273 | SectionName.ENUM_CONSTANTS_INHERITANCE, |
bpatel@2101 | 274 | configuration.getClassName(cd), writer.getResource("doclet.navEnum")); |
bpatel@2101 | 275 | } |
duke@1 | 276 | } else { |
bpatel@766 | 277 | return writer.getResource("doclet.navEnum"); |
duke@1 | 278 | } |
duke@1 | 279 | } |
duke@1 | 280 | |
bpatel@766 | 281 | /** |
bpatel@766 | 282 | * {@inheritDoc} |
bpatel@766 | 283 | */ |
bpatel@766 | 284 | protected void addNavDetailLink(boolean link, Content liNav) { |
duke@1 | 285 | if (link) { |
bpatel@2101 | 286 | liNav.addContent(writer.getHyperLink( |
bpatel@2101 | 287 | SectionName.ENUM_CONSTANT_DETAIL, |
bpatel@766 | 288 | writer.getResource("doclet.navEnum"))); |
duke@1 | 289 | } else { |
bpatel@766 | 290 | liNav.addContent(writer.getResource("doclet.navEnum")); |
duke@1 | 291 | } |
duke@1 | 292 | } |
duke@1 | 293 | } |