Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/PackageSummaryWriter.java
- changeset 766
- 90af8d87741f
- parent 554
- 9d9f26857129
- child 798
- 4868a36f6fd8
equal
deleted
inserted
replaced
| 758:bcbc86cc5b31 | 766:90af8d87741f |
|---|---|
| 34 * This code is not part of an API. | 34 * This code is not part of an API. |
| 35 * It is implementation that is subject to change. | 35 * It is implementation that is subject to change. |
| 36 * Do not use it as an API | 36 * Do not use it as an API |
| 37 * | 37 * |
| 38 * @author Jamie Ho | 38 * @author Jamie Ho |
| 39 * @author Bhavesh Patel (Modified) | |
| 39 * @since 1.5 | 40 * @since 1.5 |
| 40 */ | 41 */ |
| 41 | 42 |
| 42 public interface PackageSummaryWriter { | 43 public interface PackageSummaryWriter { |
| 43 | 44 |
| 47 * @return the name of the output file. | 48 * @return the name of the output file. |
| 48 */ | 49 */ |
| 49 public abstract String getOutputFileName(); | 50 public abstract String getOutputFileName(); |
| 50 | 51 |
| 51 /** | 52 /** |
| 52 * Write the header for the package summary. | 53 * Get the header for the summary. |
| 54 * | |
| 55 * @param heading Package name. | |
| 56 * @return the header to be added to the content tree | |
| 53 */ | 57 */ |
| 54 public abstract void writeSummaryHeader(); | 58 public abstract Content getPackageHeader(String heading); |
| 55 | 59 |
| 56 /** | 60 /** |
| 57 * Write the footer for the package summary. | 61 * Get the header for the package content. |
| 62 * | |
| 63 * @return a content tree for the package content header | |
| 58 */ | 64 */ |
| 59 public abstract void writeSummaryFooter(); | 65 public abstract Content getContentHeader(); |
| 60 | 66 |
| 61 /** | 67 /** |
| 62 * Write the table of classes in this package. | 68 * Get the header for the package summary. |
| 69 * | |
| 70 * @return a content tree with the package summary header | |
| 71 */ | |
| 72 public abstract Content getSummaryHeader(); | |
| 73 | |
| 74 /** | |
| 75 * Adds the table of classes to the documentation tree. | |
| 63 * | 76 * |
| 64 * @param classes the array of classes to document. | 77 * @param classes the array of classes to document. |
| 65 * @param label the label for this table. | 78 * @param label the label for this table. |
| 79 * @param tableSummary the summary string for the table | |
| 80 * @param tableHeader array of table headers | |
| 81 * @param summaryContentTree the content tree to which the summaries will be added | |
| 66 */ | 82 */ |
| 67 public abstract void writeClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader); | 83 public abstract void addClassesSummary(ClassDoc[] classes, String label, |
| 84 String tableSummary, String[] tableHeader, Content summaryContentTree); | |
| 68 | 85 |
| 69 /** | 86 /** |
| 70 * Write the header for the summary. | 87 * Adds the package description from the "packages.html" file to the documentation |
| 88 * tree. | |
| 71 * | 89 * |
| 72 * @param heading Package name. | 90 * @param packageContentTree the content tree to which the package description |
| 91 * will be added | |
| 73 */ | 92 */ |
| 74 public abstract void writePackageHeader(String heading); | 93 public abstract void addPackageDescription(Content packageContentTree); |
| 75 | 94 |
| 76 /** | 95 /** |
| 77 * Print the package description from the "packages.html" file. | 96 * Adds the tag information from the "packages.html" file to the documentation |
| 97 * tree. | |
| 98 * | |
| 99 * @param packageContentTree the content tree to which the package tags will | |
| 100 * be added | |
| 78 */ | 101 */ |
| 79 public abstract void writePackageDescription(); | 102 public abstract void addPackageTags(Content packageContentTree); |
| 80 | 103 |
| 81 /** | 104 /** |
| 82 * Print the tag information from the "packages.html" file. | 105 * Adds the footer to the documentation tree. |
| 106 * | |
| 107 * @param contentTree the tree to which the footer will be added | |
| 83 */ | 108 */ |
| 84 public abstract void writePackageTags(); | 109 public abstract void addPackageFooter(Content contentTree); |
| 85 | 110 |
| 86 /** | 111 /** |
| 87 * Write the footer for the summary. | 112 * Print the package summary document. |
| 88 * | 113 * |
| 114 * @param contentTree the content tree that will be printed | |
| 89 */ | 115 */ |
| 90 public abstract void writePackageFooter(); | 116 public abstract void printDocument(Content contentTree); |
| 91 | 117 |
| 92 /** | 118 /** |
| 93 * Close the writer. | 119 * Close the writer. |
| 94 */ | 120 */ |
| 95 public abstract void close() throws IOException; | 121 public abstract void close() throws IOException; |
