src/share/classes/com/sun/tools/doclets/formats/html/AbstractExecutableMemberWriter.java

changeset 1358
fc123bdeddb8
parent 798
4868a36f6fd8
child 1359
25e14ad23cef
equal deleted inserted replaced
1357:c75be5bc5283 1358:fc123bdeddb8
1 /* 1 /*
2 * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved. 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 * 4 *
5 * This code is free software; you can redistribute it and/or modify it 5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as 6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this 7 * published by the Free Software Foundation. Oracle designates this
79 79
80 /** 80 /**
81 * Add the summary link for the member. 81 * Add the summary link for the member.
82 * 82 *
83 * @param context the id of the context where the link will be printed 83 * @param context the id of the context where the link will be printed
84 * @param classDoc the classDoc that we should link to 84 * @param cd the classDoc that we should link to
85 * @param member the member being linked to 85 * @param member the member being linked to
86 * @param tdSummary the content tree to which the link will be added 86 * @param tdSummary the content tree to which the link will be added
87 */ 87 */
88 protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member, 88 protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member,
89 Content tdSummary) { 89 Content tdSummary) {
99 } 99 }
100 100
101 /** 101 /**
102 * Add the inherited summary link for the member. 102 * Add the inherited summary link for the member.
103 * 103 *
104 * @param classDoc the classDoc that we should link to 104 * @param cd the classDoc that we should link to
105 * @param member the member being linked to 105 * @param member the member being linked to
106 * @param linksTree the content tree to which the link will be added 106 * @param linksTree the content tree to which the link will be added
107 */ 107 */
108 protected void addInheritedSummaryLink(ClassDoc cd, 108 protected void addInheritedSummaryLink(ClassDoc cd,
109 ProgramElementDoc member, Content linksTree) { 109 ProgramElementDoc member, Content linksTree) {
136 136
137 /** 137 /**
138 * Add all the parameters for the executable member. 138 * Add all the parameters for the executable member.
139 * 139 *
140 * @param member the member to write parameters for. 140 * @param member the member to write parameters for.
141 * @param tree the content tree to which the parameters information will be added. 141 * @param htmltree the content tree to which the parameters information will be added.
142 */ 142 */
143 protected void addParameters(ExecutableMemberDoc member, Content htmltree) { 143 protected void addParameters(ExecutableMemberDoc member, Content htmltree) {
144 addParameters(member, true, htmltree); 144 addParameters(member, true, htmltree);
145 } 145 }
146 146
147 /** 147 /**
148 * Add all the parameters for the executable member. 148 * Add all the parameters for the executable member.
149 * 149 *
150 * @param member the member to write parameters for. 150 * @param member the member to write parameters for.
151 * @param includeAnnotations true if annotation information needs to be added. 151 * @param includeAnnotations true if annotation information needs to be added.
152 * @param tree the content tree to which the parameters information will be added. 152 * @param htmltree the content tree to which the parameters information will be added.
153 */ 153 */
154 protected void addParameters(ExecutableMemberDoc member, 154 protected void addParameters(ExecutableMemberDoc member,
155 boolean includeAnnotations, Content htmltree) { 155 boolean includeAnnotations, Content htmltree) {
156 htmltree.addContent("("); 156 htmltree.addContent("(");
157 Parameter[] params = member.parameters(); 157 Parameter[] params = member.parameters();

mercurial