author | ksrini |
Sun, 15 Jun 2014 08:41:57 -0700 | |
changeset 25454 | 376a52c9540c |
parent 15723 | 58a73dac9ee4 |
permissions | -rw-r--r-- |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
1 |
/* |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
2 |
* Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved. |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
4 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
10 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
15 |
* accompanied this code). |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
16 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
20 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
23 |
* questions. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
24 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
25 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
26 |
package com.sun.tools.doclets.internal.toolkit.builders; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
27 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
28 |
import java.io.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
29 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
30 |
import com.sun.javadoc.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
31 |
import com.sun.tools.javac.jvm.Profile; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
32 |
import com.sun.tools.doclets.internal.toolkit.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
33 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
34 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
35 |
* Builds the summary for a given profile package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
36 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
37 |
* <p><b>This is NOT part of any supported API. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
38 |
* If you write code that depends on this, you do so at your own risk. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
39 |
* This code and its internal interfaces are subject to change or |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
40 |
* deletion without notice.</b> |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
41 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
42 |
* @author Bhavesh Patel |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
43 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
44 |
public class ProfilePackageSummaryBuilder extends AbstractBuilder { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
45 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
46 |
* The root element of the profile package summary XML is {@value}. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
47 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
48 |
public static final String ROOT = "PackageDoc"; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
49 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
50 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
51 |
* The profile package being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
52 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
53 |
private final PackageDoc packageDoc; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
54 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
55 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
56 |
* The name of the profile being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
57 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
58 |
private final String profileName; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
59 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
60 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
61 |
* The value of the profile being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
62 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
63 |
private final int profileValue; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
64 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
65 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
66 |
* The doclet specific writer that will output the result. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
67 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
68 |
private final ProfilePackageSummaryWriter profilePackageWriter; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
69 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
70 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
71 |
* The content that will be added to the profile package summary documentation tree. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
72 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
73 |
private Content contentTree; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
74 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
75 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
76 |
* Construct a new ProfilePackageSummaryBuilder. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
77 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
78 |
* @param context the build context. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
79 |
* @param pkg the profile package being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
80 |
* @param profilePackageWriter the doclet specific writer that will output the |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
81 |
* result. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
82 |
* @param profile the profile being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
83 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
84 |
private ProfilePackageSummaryBuilder(Context context, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
85 |
PackageDoc pkg, ProfilePackageSummaryWriter profilePackageWriter, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
86 |
Profile profile) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
87 |
super(context); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
88 |
this.packageDoc = pkg; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
89 |
this.profilePackageWriter = profilePackageWriter; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
90 |
this.profileName = profile.name; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
91 |
this.profileValue = profile.value; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
92 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
93 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
94 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
95 |
* Construct a new ProfilePackageSummaryBuilder. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
96 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
97 |
* @param context the build context. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
98 |
* @param pkg the profile package being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
99 |
* @param profilePackageWriter the doclet specific writer that will output the |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
100 |
* result. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
101 |
* @param profile the profile being documented. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
102 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
103 |
* @return an instance of a ProfilePackageSummaryBuilder. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
104 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
105 |
public static ProfilePackageSummaryBuilder getInstance(Context context, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
106 |
PackageDoc pkg, ProfilePackageSummaryWriter profilePackageWriter, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
107 |
Profile profile) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
108 |
return new ProfilePackageSummaryBuilder(context, pkg, profilePackageWriter, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
109 |
profile); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
110 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
111 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
112 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
113 |
* Build the profile package summary. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
114 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
115 |
public void build() throws IOException { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
116 |
if (profilePackageWriter == null) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
117 |
//Doclet does not support this output. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
118 |
return; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
119 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
120 |
build(layoutParser.parseXML(ROOT), contentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
121 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
122 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
123 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
124 |
* {@inheritDoc} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
125 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
126 |
public String getName() { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
127 |
return ROOT; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
128 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
129 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
130 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
131 |
* Build the profile package documentation. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
132 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
133 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
134 |
* @param contentTree the content tree to which the documentation will be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
135 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
136 |
public void buildPackageDoc(XMLNode node, Content contentTree) throws Exception { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
137 |
contentTree = profilePackageWriter.getPackageHeader( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
138 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
139 |
buildChildren(node, contentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
140 |
profilePackageWriter.addPackageFooter(contentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
141 |
profilePackageWriter.printDocument(contentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
142 |
profilePackageWriter.close(); |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
143 |
utils.copyDocFiles(configuration, packageDoc); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
144 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
145 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
146 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
147 |
* Build the content for the profile package doc. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
148 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
149 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
150 |
* @param contentTree the content tree to which the package contents |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
151 |
* will be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
152 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
153 |
public void buildContent(XMLNode node, Content contentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
154 |
Content packageContentTree = profilePackageWriter.getContentHeader(); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
155 |
buildChildren(node, packageContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
156 |
contentTree.addContent(packageContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
157 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
158 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
159 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
160 |
* Build the profile package summary. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
161 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
162 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
163 |
* @param packageContentTree the package content tree to which the summaries will |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
164 |
* be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
165 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
166 |
public void buildSummary(XMLNode node, Content packageContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
167 |
Content summaryContentTree = profilePackageWriter.getSummaryHeader(); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
168 |
buildChildren(node, summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
169 |
packageContentTree.addContent(summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
170 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
171 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
172 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
173 |
* Build the summary for the interfaces in this package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
174 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
175 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
176 |
* @param summaryContentTree the summary tree to which the interface summary |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
177 |
* will be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
178 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
179 |
public void buildInterfaceSummary(XMLNode node, Content summaryContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
180 |
String interfaceTableSummary = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
181 |
configuration.getText("doclet.Member_Table_Summary", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
182 |
configuration.getText("doclet.Interface_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
183 |
configuration.getText("doclet.interfaces")); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
184 |
String[] interfaceTableHeader = new String[] { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
185 |
configuration.getText("doclet.Interface"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
186 |
configuration.getText("doclet.Description") |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
187 |
}; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
188 |
ClassDoc[] interfaces = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
189 |
packageDoc.isIncluded() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
190 |
? packageDoc.interfaces() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
191 |
: configuration.classDocCatalog.interfaces( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
192 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
193 |
if (interfaces.length > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
194 |
profilePackageWriter.addClassesSummary( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
195 |
interfaces, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
196 |
configuration.getText("doclet.Interface_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
197 |
interfaceTableSummary, interfaceTableHeader, summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
198 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
199 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
200 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
201 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
202 |
* Build the summary for the classes in this package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
203 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
204 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
205 |
* @param summaryContentTree the summary tree to which the class summary will |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
206 |
* be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
207 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
208 |
public void buildClassSummary(XMLNode node, Content summaryContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
209 |
String classTableSummary = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
210 |
configuration.getText("doclet.Member_Table_Summary", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
211 |
configuration.getText("doclet.Class_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
212 |
configuration.getText("doclet.classes")); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
213 |
String[] classTableHeader = new String[] { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
214 |
configuration.getText("doclet.Class"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
215 |
configuration.getText("doclet.Description") |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
216 |
}; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
217 |
ClassDoc[] classes = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
218 |
packageDoc.isIncluded() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
219 |
? packageDoc.ordinaryClasses() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
220 |
: configuration.classDocCatalog.ordinaryClasses( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
221 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
222 |
if (classes.length > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
223 |
profilePackageWriter.addClassesSummary( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
224 |
classes, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
225 |
configuration.getText("doclet.Class_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
226 |
classTableSummary, classTableHeader, summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
227 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
228 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
229 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
230 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
231 |
* Build the summary for the enums in this package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
232 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
233 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
234 |
* @param summaryContentTree the summary tree to which the enum summary will |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
235 |
* be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
236 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
237 |
public void buildEnumSummary(XMLNode node, Content summaryContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
238 |
String enumTableSummary = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
239 |
configuration.getText("doclet.Member_Table_Summary", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
240 |
configuration.getText("doclet.Enum_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
241 |
configuration.getText("doclet.enums")); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
242 |
String[] enumTableHeader = new String[] { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
243 |
configuration.getText("doclet.Enum"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
244 |
configuration.getText("doclet.Description") |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
245 |
}; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
246 |
ClassDoc[] enums = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
247 |
packageDoc.isIncluded() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
248 |
? packageDoc.enums() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
249 |
: configuration.classDocCatalog.enums( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
250 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
251 |
if (enums.length > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
252 |
profilePackageWriter.addClassesSummary( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
253 |
enums, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
254 |
configuration.getText("doclet.Enum_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
255 |
enumTableSummary, enumTableHeader, summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
256 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
257 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
258 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
259 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
260 |
* Build the summary for the exceptions in this package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
261 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
262 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
263 |
* @param summaryContentTree the summary tree to which the exception summary will |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
264 |
* be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
265 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
266 |
public void buildExceptionSummary(XMLNode node, Content summaryContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
267 |
String exceptionTableSummary = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
268 |
configuration.getText("doclet.Member_Table_Summary", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
269 |
configuration.getText("doclet.Exception_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
270 |
configuration.getText("doclet.exceptions")); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
271 |
String[] exceptionTableHeader = new String[] { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
272 |
configuration.getText("doclet.Exception"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
273 |
configuration.getText("doclet.Description") |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
274 |
}; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
275 |
ClassDoc[] exceptions = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
276 |
packageDoc.isIncluded() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
277 |
? packageDoc.exceptions() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
278 |
: configuration.classDocCatalog.exceptions( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
279 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
280 |
if (exceptions.length > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
281 |
profilePackageWriter.addClassesSummary( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
282 |
exceptions, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
283 |
configuration.getText("doclet.Exception_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
284 |
exceptionTableSummary, exceptionTableHeader, summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
285 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
286 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
287 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
288 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
289 |
* Build the summary for the errors in this package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
290 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
291 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
292 |
* @param summaryContentTree the summary tree to which the error summary will |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
293 |
* be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
294 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
295 |
public void buildErrorSummary(XMLNode node, Content summaryContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
296 |
String errorTableSummary = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
297 |
configuration.getText("doclet.Member_Table_Summary", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
298 |
configuration.getText("doclet.Error_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
299 |
configuration.getText("doclet.errors")); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
300 |
String[] errorTableHeader = new String[] { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
301 |
configuration.getText("doclet.Error"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
302 |
configuration.getText("doclet.Description") |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
303 |
}; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
304 |
ClassDoc[] errors = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
305 |
packageDoc.isIncluded() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
306 |
? packageDoc.errors() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
307 |
: configuration.classDocCatalog.errors( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
308 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
309 |
if (errors.length > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
310 |
profilePackageWriter.addClassesSummary( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
311 |
errors, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
312 |
configuration.getText("doclet.Error_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
313 |
errorTableSummary, errorTableHeader, summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
314 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
315 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
316 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
317 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
318 |
* Build the summary for the annotation type in this package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
319 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
320 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
321 |
* @param summaryContentTree the summary tree to which the annotation type |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
322 |
* summary will be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
323 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
324 |
public void buildAnnotationTypeSummary(XMLNode node, Content summaryContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
325 |
String annotationtypeTableSummary = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
326 |
configuration.getText("doclet.Member_Table_Summary", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
327 |
configuration.getText("doclet.Annotation_Types_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
328 |
configuration.getText("doclet.annotationtypes")); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
329 |
String[] annotationtypeTableHeader = new String[] { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
330 |
configuration.getText("doclet.AnnotationType"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
331 |
configuration.getText("doclet.Description") |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
332 |
}; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
333 |
ClassDoc[] annotationTypes = |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
334 |
packageDoc.isIncluded() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
335 |
? packageDoc.annotationTypes() |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
336 |
: configuration.classDocCatalog.annotationTypes( |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
15723
diff
changeset
|
337 |
utils.getPackageName(packageDoc)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
338 |
if (annotationTypes.length > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
339 |
profilePackageWriter.addClassesSummary( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
340 |
annotationTypes, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
341 |
configuration.getText("doclet.Annotation_Types_Summary"), |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
342 |
annotationtypeTableSummary, annotationtypeTableHeader, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
343 |
summaryContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
344 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
345 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
346 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
347 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
348 |
* Build the description of the summary. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
349 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
350 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
351 |
* @param packageContentTree the tree to which the package description will |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
352 |
* be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
353 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
354 |
public void buildPackageDescription(XMLNode node, Content packageContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
355 |
if (configuration.nocomment) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
356 |
return; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
357 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
358 |
profilePackageWriter.addPackageDescription(packageContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
359 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
360 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
361 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
362 |
* Build the tags of the summary. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
363 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
364 |
* @param node the XML element that specifies which components to document |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
365 |
* @param packageContentTree the tree to which the package tags will be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
366 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
367 |
public void buildPackageTags(XMLNode node, Content packageContentTree) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
368 |
if (configuration.nocomment) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
369 |
return; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
370 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
371 |
profilePackageWriter.addPackageTags(packageContentTree); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
372 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
373 |
} |