archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 07:14:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8239816: Make handling of module / package / types consistent

Browse source 
Reviewed-by: hannesw
This commit is contained in:
Jonathan Gibbons 2020-05-18 13:24:35 -07:00
parent b26516309a
commit 039cb65753
5 changed files with 17 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java
View file

@ -840,17 +840,11 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
addDeprecationInfo(tree);
tree.add(MarkerComments.START_OF_MODULE_DESCRIPTION);
addInlineComment(mdle, tree);
addTagsInfo(mdle, tree);
moduleContentTree.add(tree);
}
}
@Override
public void addModuleTags(Content moduleContentTree) {
Content tree = HtmlTree.SECTION(HtmlStyle.moduleTags);
addTagsInfo(mdle, tree);
moduleContentTree.add(tree);
}
@Override
public void addModuleContent(Content moduleContentTree) {
bodyContents.addMainContent(moduleContentTree);

8
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java
View file

@ -231,14 +231,6 @@ public enum HtmlStyle {
*/
moduleDescription,
/**
* The class of the {@code dl} element used to present the block tags in the documentation
* comment for a module element.
* Additional (derived) information, such as implementation or inheritance details, may
* also appear in this element.
*/
moduleTags,
/**
* The class of the element used to present the documentation comment for package element.
* The content of the block tags will be in a nested element with class {@link #notes}.

9
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java
View file

@ -76,15 +76,6 @@ public interface ModuleSummaryWriter {
*/
void addModuleDescription(Content moduleContentTree);
/**
* Adds the tag information from the "module-info.java" file to the documentation
* tree.
*
* @param moduleContentTree the content tree to which the module tags will
* be added
*/
void addModuleTags(Content moduleContentTree);
/**
* Adds the summary of modules to the list of summaries.
*

12
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ModuleSummaryBuilder.java
View file

@ -122,7 +122,6 @@ public class ModuleSummaryBuilder extends AbstractBuilder {
Content moduleContentTree = moduleWriter.getContentHeader();
buildModuleDescription(moduleContentTree);
buildModuleTags(moduleContentTree);
buildSummary(moduleContentTree);
moduleWriter.addModuleContent(moduleContentTree);
@ -183,15 +182,4 @@ public class ModuleSummaryBuilder extends AbstractBuilder {
moduleWriter.addModuleDescription(moduleContentTree);
}
}
/**
* Build the tags of the summary.
*
* @param moduleContentTree the tree to which the module tags will be added
*/
protected void buildModuleTags(Content moduleContentTree) {
if (!options.noComment()) {
moduleWriter.addModuleTags(moduleContentTree);
}
}
}