author | hannesw |
Wed, 27 Nov 2019 13:08:16 +0100 | |
changeset 59294 | 48b88b9c11eb |
parent 47216 | 71c04702a3d5 |
permissions | -rw-r--r-- |
36526 | 1 |
/* |
2 |
* Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved. |
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 |
* |
|
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 |
|
7 |
* published by the Free Software Foundation. Oracle designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
|
10 |
* |
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
||
26 |
package jdk.javadoc.internal.doclets.toolkit; |
|
27 |
||
40587 | 28 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
36526 | 29 |
|
30 |
/** |
|
31 |
* The interface for writing module summary output. |
|
32 |
* |
|
33 |
* <p><b>This is NOT part of any supported API. |
|
34 |
* If you write code that depends on this, you do so at your own risk. |
|
35 |
* This code and its internal interfaces are subject to change or |
|
36 |
* deletion without notice.</b> |
|
37 |
* |
|
38 |
* @author Bhavesh Patel |
|
39 |
*/ |
|
40 |
||
41 |
public interface ModuleSummaryWriter { |
|
42 |
||
43 |
/** |
|
44 |
* Get the header for the summary. |
|
45 |
* |
|
46 |
* @param heading module name. |
|
47 |
* @return the header to be added to the content tree |
|
48 |
*/ |
|
49 |
public abstract Content getModuleHeader(String heading); |
|
50 |
||
51 |
/** |
|
52 |
* Get the header for the module content. |
|
53 |
* |
|
54 |
* @return a content tree for the module content header |
|
55 |
*/ |
|
56 |
public abstract Content getContentHeader(); |
|
57 |
||
58 |
/** |
|
59 |
* Get the header for the summary header. |
|
60 |
* |
|
61 |
* @return a content tree with the summary header |
|
62 |
*/ |
|
63 |
public abstract Content getSummaryHeader(); |
|
64 |
||
65 |
/** |
|
66 |
* Get the header for the summary tree. |
|
67 |
* |
|
68 |
* @param summaryContentTree the content tree. |
|
69 |
* @return a content tree with the summary tree |
|
70 |
*/ |
|
71 |
public abstract Content getSummaryTree(Content summaryContentTree); |
|
72 |
||
73 |
/** |
|
37747
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
74 |
* Adds the module description. |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
75 |
* |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
76 |
* @param moduleContentTree the content tree to which the module description |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
77 |
* will be added |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
78 |
*/ |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
79 |
public abstract void addModuleDescription(Content moduleContentTree); |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
80 |
|
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
81 |
/** |
38911
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
82 |
* Adds the tag information from the "module-info.java" file to the documentation |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
83 |
* tree. |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
84 |
* |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
85 |
* @param moduleContentTree the content tree to which the module tags will |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
86 |
* be added |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
87 |
*/ |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
88 |
public abstract void addModuleTags(Content moduleContentTree); |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
89 |
|
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37747
diff
changeset
|
90 |
/** |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
91 |
* Adds the modules summary to the documentation tree. |
36526 | 92 |
* |
93 |
* @param summaryContentTree the content tree to which the summary will be added |
|
94 |
*/ |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
95 |
public abstract void addModulesSummary(Content summaryContentTree); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
96 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
97 |
/** |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
98 |
* Adds the packages summary to the documentation tree. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
99 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
100 |
* @param summaryContentTree the content tree to which the summary will be added |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
101 |
*/ |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
102 |
public abstract void addPackagesSummary(Content summaryContentTree); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
103 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
104 |
/** |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
105 |
* Adds the services summary to the documentation tree. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
106 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
107 |
* @param summaryContentTree the content tree to which the summary will be added |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
108 |
*/ |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
109 |
public abstract void addServicesSummary(Content summaryContentTree); |
36526 | 110 |
|
111 |
/** |
|
112 |
* Adds the module content tree to the documentation tree. |
|
113 |
* |
|
114 |
* @param moduleContentTree the content tree that will be added |
|
115 |
*/ |
|
59294
48b88b9c11eb
8223378: CSS solution for navbar problem with <a> elements is not ideal
hannesw
parents:
47216
diff
changeset
|
116 |
public abstract void addModuleContent(Content moduleContentTree); |
36526 | 117 |
|
118 |
/** |
|
119 |
* Adds the footer to the documentation tree. |
|
120 |
*/ |
|
59294
48b88b9c11eb
8223378: CSS solution for navbar problem with <a> elements is not ideal
hannesw
parents:
47216
diff
changeset
|
121 |
public abstract void addModuleFooter(); |
36526 | 122 |
|
123 |
/** |
|
124 |
* Print the module summary document. |
|
125 |
* |
|
126 |
* @param contentTree the content tree that will be printed |
|
40587 | 127 |
* @throws DocFileIOException if there is a problem while writing the document |
36526 | 128 |
*/ |
40587 | 129 |
public abstract void printDocument(Content contentTree) throws DocFileIOException; |
36526 | 130 |
} |