40 import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
40 import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
41 import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
41 import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
42 import jdk.javadoc.internal.doclets.toolkit.util.Group; |
42 import jdk.javadoc.internal.doclets.toolkit.util.Group; |
43 |
43 |
44 /** |
44 /** |
45 * Generate the package index page "overview-summary.html" for the right-hand |
45 * Generate the package index page "index.html". |
46 * frame. A click on the package name on this page will update the same frame |
|
47 * with the "package-summary.html" file for the clicked package. |
|
48 * |
46 * |
49 * <p><b>This is NOT part of any supported API. |
47 * <p><b>This is NOT part of any supported API. |
50 * If you write code that depends on this, you do so at your own risk. |
48 * If you write code that depends on this, you do so at your own risk. |
51 * This code and its internal interfaces are subject to change or |
49 * This code and its internal interfaces are subject to change or |
52 * deletion without notice.</b> |
50 * deletion without notice.</b> |
68 public PackageIndexWriter(HtmlConfiguration configuration, DocPath filename) { |
66 public PackageIndexWriter(HtmlConfiguration configuration, DocPath filename) { |
69 super(configuration, filename); |
67 super(configuration, filename); |
70 } |
68 } |
71 |
69 |
72 /** |
70 /** |
73 * Generate the package index page for the right-hand frame. |
71 * Generate the package index page. |
74 * |
72 * |
75 * @param configuration the current configuration of the doclet. |
73 * @param configuration the current configuration of the doclet. |
76 * @throws DocFileIOException if there is a problem generating the package index page |
74 * @throws DocFileIOException if there is a problem generating the package index page |
77 */ |
75 */ |
78 public static void generate(HtmlConfiguration configuration) throws DocFileIOException { |
76 public static void generate(HtmlConfiguration configuration) throws DocFileIOException { |
79 DocPath filename = DocPaths.overviewSummary(configuration.frames); |
77 DocPath filename = DocPaths.INDEX; |
80 PackageIndexWriter packgen = new PackageIndexWriter(configuration, filename); |
78 PackageIndexWriter packgen = new PackageIndexWriter(configuration, filename); |
81 packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", "package index", true); |
79 packgen.buildPackageIndexFile("doclet.Window_Overview_Summary", "package index"); |
82 } |
80 } |
83 |
81 |
84 /** |
82 /** |
85 * Depending upon the grouping information and their titles, add |
83 * Depending upon the grouping information and their titles, add |
86 * separate table indices for each package group. |
84 * separate table indices for each package group. |