142 buildPackageDescription(packageContentTree);
143 buildPackageTags(packageContentTree);
144 buildSummary(packageContentTree);
145
146 packageWriter.addPackageContent(contentTree, packageContentTree);
147 }
148
149 /**
150 * Build the package summary.
151 *
152 * @param packageContentTree the package content tree to which the summaries will
153 * be added
154 * @throws DocletException if there is a problem while building the documentation
155 */
156 protected void buildSummary(Content packageContentTree) throws DocletException {
157 Content summaryContentTree = packageWriter.getSummaryHeader();
158
159 buildInterfaceSummary(summaryContentTree);
160 buildClassSummary(summaryContentTree);
161 buildEnumSummary(summaryContentTree);
162 buildExceptionSummary(summaryContentTree);
163 buildErrorSummary(summaryContentTree);
164 buildAnnotationTypeSummary(summaryContentTree);
165
166 packageContentTree.add(packageWriter.getPackageSummary(summaryContentTree));
167 }
168
169 /**
170 * Build the summary for the interfaces in this package.
171 *
172 * @param summaryContentTree the summary tree to which the interface summary
173 * will be added
174 */
175 protected void buildInterfaceSummary(Content summaryContentTree) {
176 SortedSet<TypeElement> ilist = utils.isSpecified(packageElement)
177 ? utils.getTypeElementsAsSortedSet(utils.getInterfaces(packageElement))
178 : configuration.typeElementCatalog.interfaces(packageElement);
179 SortedSet<TypeElement> interfaces = utils.filterOutPrivateClasses(ilist, configuration.javafx);
180 if (!interfaces.isEmpty()) {
181 packageWriter.addInterfaceSummary(interfaces, summaryContentTree);
194 : configuration.typeElementCatalog.ordinaryClasses(packageElement);
195 SortedSet<TypeElement> classes = utils.filterOutPrivateClasses(clist, configuration.javafx);
196 if (!classes.isEmpty()) {
197 packageWriter.addClassSummary(classes, summaryContentTree);
198 }
199 }
200
201 /**
202 * Build the summary for the enums in this package.
203 *
204 * @param summaryContentTree the summary tree to which the enum summary will
205 * be added
206 */
207 protected void buildEnumSummary(Content summaryContentTree) {
208 SortedSet<TypeElement> elist = utils.isSpecified(packageElement)
209 ? utils.getTypeElementsAsSortedSet(utils.getEnums(packageElement))
210 : configuration.typeElementCatalog.enums(packageElement);
211 SortedSet<TypeElement> enums = utils.filterOutPrivateClasses(elist, configuration.javafx);
212 if (!enums.isEmpty()) {
213 packageWriter.addEnumSummary(enums, summaryContentTree);
214 }
215 }
216
217 /**
218 * Build the summary for the exceptions in this package.
219 *
220 * @param summaryContentTree the summary tree to which the exception summary will
221 * be added
222 */
223 protected void buildExceptionSummary(Content summaryContentTree) {
224 Set<TypeElement> iexceptions =
225 utils.isSpecified(packageElement)
226 ? utils.getTypeElementsAsSortedSet(utils.getExceptions(packageElement))
227 : configuration.typeElementCatalog.exceptions(packageElement);
228 SortedSet<TypeElement> exceptions = utils.filterOutPrivateClasses(iexceptions,
229 configuration.javafx);
230 if (!exceptions.isEmpty()) {
231 packageWriter.addExceptionSummary(exceptions, summaryContentTree);
232 }
233 }
|
142 buildPackageDescription(packageContentTree);
143 buildPackageTags(packageContentTree);
144 buildSummary(packageContentTree);
145
146 packageWriter.addPackageContent(contentTree, packageContentTree);
147 }
148
149 /**
150 * Build the package summary.
151 *
152 * @param packageContentTree the package content tree to which the summaries will
153 * be added
154 * @throws DocletException if there is a problem while building the documentation
155 */
156 protected void buildSummary(Content packageContentTree) throws DocletException {
157 Content summaryContentTree = packageWriter.getSummaryHeader();
158
159 buildInterfaceSummary(summaryContentTree);
160 buildClassSummary(summaryContentTree);
161 buildEnumSummary(summaryContentTree);
162 buildRecordSummary(summaryContentTree);
163 buildExceptionSummary(summaryContentTree);
164 buildErrorSummary(summaryContentTree);
165 buildAnnotationTypeSummary(summaryContentTree);
166
167 packageContentTree.add(packageWriter.getPackageSummary(summaryContentTree));
168 }
169
170 /**
171 * Build the summary for the interfaces in this package.
172 *
173 * @param summaryContentTree the summary tree to which the interface summary
174 * will be added
175 */
176 protected void buildInterfaceSummary(Content summaryContentTree) {
177 SortedSet<TypeElement> ilist = utils.isSpecified(packageElement)
178 ? utils.getTypeElementsAsSortedSet(utils.getInterfaces(packageElement))
179 : configuration.typeElementCatalog.interfaces(packageElement);
180 SortedSet<TypeElement> interfaces = utils.filterOutPrivateClasses(ilist, configuration.javafx);
181 if (!interfaces.isEmpty()) {
182 packageWriter.addInterfaceSummary(interfaces, summaryContentTree);
195 : configuration.typeElementCatalog.ordinaryClasses(packageElement);
196 SortedSet<TypeElement> classes = utils.filterOutPrivateClasses(clist, configuration.javafx);
197 if (!classes.isEmpty()) {
198 packageWriter.addClassSummary(classes, summaryContentTree);
199 }
200 }
201
202 /**
203 * Build the summary for the enums in this package.
204 *
205 * @param summaryContentTree the summary tree to which the enum summary will
206 * be added
207 */
208 protected void buildEnumSummary(Content summaryContentTree) {
209 SortedSet<TypeElement> elist = utils.isSpecified(packageElement)
210 ? utils.getTypeElementsAsSortedSet(utils.getEnums(packageElement))
211 : configuration.typeElementCatalog.enums(packageElement);
212 SortedSet<TypeElement> enums = utils.filterOutPrivateClasses(elist, configuration.javafx);
213 if (!enums.isEmpty()) {
214 packageWriter.addEnumSummary(enums, summaryContentTree);
215 }
216 }
217
218 /**
219 * Build the summary for the records in this package.
220 *
221 * @param summaryContentTree the summary tree to which the record summary will
222 * be added
223 */
224 protected void buildRecordSummary(Content summaryContentTree) {
225 SortedSet<TypeElement> rlist = utils.isSpecified(packageElement)
226 ? utils.getTypeElementsAsSortedSet(utils.getRecords(packageElement))
227 : configuration.typeElementCatalog.records(packageElement);
228 SortedSet<TypeElement> records = utils.filterOutPrivateClasses(rlist, configuration.javafx);
229 if (!records.isEmpty()) {
230 packageWriter.addRecordSummary(records, summaryContentTree);
231 }
232 }
233
234 /**
235 * Build the summary for the exceptions in this package.
236 *
237 * @param summaryContentTree the summary tree to which the exception summary will
238 * be added
239 */
240 protected void buildExceptionSummary(Content summaryContentTree) {
241 Set<TypeElement> iexceptions =
242 utils.isSpecified(packageElement)
243 ? utils.getTypeElementsAsSortedSet(utils.getExceptions(packageElement))
244 : configuration.typeElementCatalog.exceptions(packageElement);
245 SortedSet<TypeElement> exceptions = utils.filterOutPrivateClasses(iexceptions,
246 configuration.javafx);
247 if (!exceptions.isEmpty()) {
248 packageWriter.addExceptionSummary(exceptions, summaryContentTree);
249 }
250 }
|