8241895: use new "details-list" CSS class instead of general "block-list" for list of details sections
Reviewed-by: hannesw
This commit is contained in:
parent
8523e37f7e
commit
7ac64b81ee
@ -153,16 +153,13 @@ public class ConstructorWriterImpl extends AbstractExecutableMemberWriter
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Content getConstructorDetails(Content constructorDetailsTreeHeader, Content constructorDetailsTree) {
|
public Content getConstructorDetails(Content constructorDetailsTreeHeader, Content constructorDetailsTree) {
|
||||||
Content constructorDetails = new ContentBuilder(constructorDetailsTreeHeader, constructorDetailsTree);
|
return writer.getDetailsListItem(
|
||||||
return getMemberTree(HtmlTree.SECTION(HtmlStyle.constructorDetails, constructorDetails)
|
HtmlTree.SECTION(HtmlStyle.constructorDetails)
|
||||||
.setId(SectionName.CONSTRUCTOR_DETAIL.getName()));
|
.setId(SectionName.CONSTRUCTOR_DETAIL.getName())
|
||||||
|
.add(constructorDetailsTreeHeader)
|
||||||
|
.add(constructorDetailsTree));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Let the writer know whether a non public constructor was found.
|
|
||||||
*
|
|
||||||
* @param foundNonPubConstructor true if we found a non public constructor.
|
|
||||||
*/
|
|
||||||
@Override
|
@Override
|
||||||
public void setFoundNonPubConstructor(boolean foundNonPubConstructor) {
|
public void setFoundNonPubConstructor(boolean foundNonPubConstructor) {
|
||||||
this.foundNonPubConstructor = foundNonPubConstructor;
|
this.foundNonPubConstructor = foundNonPubConstructor;
|
||||||
|
@ -121,10 +121,11 @@ public class EnumConstantWriterImpl extends AbstractMemberWriter
|
|||||||
@Override
|
@Override
|
||||||
public Content getEnumConstantsDetails(Content enumConstantsDetailsTreeHeader,
|
public Content getEnumConstantsDetails(Content enumConstantsDetailsTreeHeader,
|
||||||
Content enumConstantsDetailsTree) {
|
Content enumConstantsDetailsTree) {
|
||||||
Content enumConstantsDetails =
|
return writer.getDetailsListItem(
|
||||||
new ContentBuilder(enumConstantsDetailsTreeHeader, enumConstantsDetailsTree);
|
HtmlTree.SECTION(HtmlStyle.constantDetails)
|
||||||
return getMemberTree(HtmlTree.SECTION(HtmlStyle.constantDetails, enumConstantsDetails)
|
.setId(SectionName.ENUM_CONSTANT_DETAIL.getName())
|
||||||
.setId(SectionName.ENUM_CONSTANT_DETAIL.getName()));
|
.add(enumConstantsDetailsTreeHeader)
|
||||||
|
.add(enumConstantsDetailsTree));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -122,9 +122,11 @@ public class FieldWriterImpl extends AbstractMemberWriter
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Content getFieldDetails(Content fieldDetailsTreeHeader, Content fieldDetailsTree) {
|
public Content getFieldDetails(Content fieldDetailsTreeHeader, Content fieldDetailsTree) {
|
||||||
Content fieldDetails = new ContentBuilder(fieldDetailsTreeHeader, fieldDetailsTree);
|
return writer.getDetailsListItem(
|
||||||
return getMemberTree(HtmlTree.SECTION(HtmlStyle.fieldDetails, fieldDetails)
|
HtmlTree.SECTION(HtmlStyle.fieldDetails)
|
||||||
.setId(SectionName.FIELD_DETAIL.getName()));
|
.setId(SectionName.FIELD_DETAIL.getName())
|
||||||
|
.add(fieldDetailsTreeHeader)
|
||||||
|
.add(fieldDetailsTree));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -134,9 +134,11 @@ public class PropertyWriterImpl extends AbstractMemberWriter
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public Content getPropertyDetails(Content propertyDetailsTreeHeader, Content propertyDetailsTree) {
|
public Content getPropertyDetails(Content propertyDetailsTreeHeader, Content propertyDetailsTree) {
|
||||||
Content propertyDetails = new ContentBuilder(propertyDetailsTreeHeader, propertyDetailsTree);
|
return writer.getDetailsListItem(
|
||||||
return getMemberTree(HtmlTree.SECTION(HtmlStyle.propertyDetails, propertyDetails)
|
HtmlTree.SECTION(HtmlStyle.propertyDetails)
|
||||||
.setId(SectionName.PROPERTY_DETAIL.getName()));
|
.setId(SectionName.PROPERTY_DETAIL.getName())
|
||||||
|
.add(propertyDetailsTreeHeader)
|
||||||
|
.add(propertyDetailsTree));
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@ -212,6 +212,25 @@ public abstract class SubWriterHolderWriter extends HtmlDocletWriter {
|
|||||||
return ul;
|
return ul;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a list to be used for the list of details for members of a given kind.
|
||||||
|
*
|
||||||
|
* @return a list to be used for the list of details for members of a given kind
|
||||||
|
*/
|
||||||
|
public Content getDetailsList() {
|
||||||
|
return new HtmlTree(TagName.UL).setStyle(HtmlStyle.detailsList);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an item for the list of details for members of a given kind.
|
||||||
|
*
|
||||||
|
* @param content content for the item
|
||||||
|
* @return an item for the list of details for members of a given kind
|
||||||
|
*/
|
||||||
|
public Content getDetailsListItem(Content content) {
|
||||||
|
return HtmlTree.LI(content);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a list to be used for the list of members of a given kind.
|
* Returns a list to be used for the list of members of a given kind.
|
||||||
*
|
*
|
||||||
@ -224,11 +243,11 @@ public abstract class SubWriterHolderWriter extends HtmlDocletWriter {
|
|||||||
/**
|
/**
|
||||||
* Returns an item for the list of elements of a given kind
|
* Returns an item for the list of elements of a given kind
|
||||||
*
|
*
|
||||||
* @param contentTree the tree used to generate the complete member tree
|
* @param content content for the item
|
||||||
* @return an item for the list of elements of a given kind
|
* @return an item for the list of elements of a given kind
|
||||||
*/
|
*/
|
||||||
public Content getMemberListItem(Content contentTree) {
|
public Content getMemberListItem(Content content) {
|
||||||
return HtmlTree.LI(contentTree);
|
return HtmlTree.LI(content);
|
||||||
}
|
}
|
||||||
|
|
||||||
public Content getMemberInheritedTree() {
|
public Content getMemberInheritedTree() {
|
||||||
|
@ -97,29 +97,29 @@ public class WriterFactoryImpl implements WriterFactory {
|
|||||||
|
|
||||||
@Override
|
@Override
|
||||||
public EnumConstantWriterImpl getEnumConstantWriter(ClassWriter classWriter) {
|
public EnumConstantWriterImpl getEnumConstantWriter(ClassWriter classWriter) {
|
||||||
return new EnumConstantWriterImpl((SubWriterHolderWriter) classWriter,
|
return new EnumConstantWriterImpl((ClassWriterImpl) classWriter,
|
||||||
classWriter.getTypeElement());
|
classWriter.getTypeElement());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public FieldWriterImpl getFieldWriter(ClassWriter classWriter) {
|
public FieldWriterImpl getFieldWriter(ClassWriter classWriter) {
|
||||||
return new FieldWriterImpl((SubWriterHolderWriter) classWriter, classWriter.getTypeElement());
|
return new FieldWriterImpl((ClassWriterImpl) classWriter, classWriter.getTypeElement());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public PropertyWriterImpl getPropertyWriter(ClassWriter classWriter) {
|
public PropertyWriterImpl getPropertyWriter(ClassWriter classWriter) {
|
||||||
return new PropertyWriterImpl((SubWriterHolderWriter) classWriter,
|
return new PropertyWriterImpl((ClassWriterImpl) classWriter,
|
||||||
classWriter.getTypeElement());
|
classWriter.getTypeElement());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public MethodWriterImpl getMethodWriter(ClassWriter classWriter) {
|
public MethodWriterImpl getMethodWriter(ClassWriter classWriter) {
|
||||||
return new MethodWriterImpl((SubWriterHolderWriter) classWriter, classWriter.getTypeElement());
|
return new MethodWriterImpl((ClassWriterImpl) classWriter, classWriter.getTypeElement());
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public ConstructorWriterImpl getConstructorWriter(ClassWriter classWriter) {
|
public ConstructorWriterImpl getConstructorWriter(ClassWriter classWriter) {
|
||||||
return new ConstructorWriterImpl((SubWriterHolderWriter) classWriter,
|
return new ConstructorWriterImpl((ClassWriterImpl) classWriter,
|
||||||
classWriter.getTypeElement());
|
classWriter.getTypeElement());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -68,6 +68,7 @@ public enum HtmlStyle {
|
|||||||
deprecationComment,
|
deprecationComment,
|
||||||
descfrmTypeLabel,
|
descfrmTypeLabel,
|
||||||
details,
|
details,
|
||||||
|
detailsList,
|
||||||
detail,
|
detail,
|
||||||
externalLink,
|
externalLink,
|
||||||
fieldDetails,
|
fieldDetails,
|
||||||
|
@ -171,6 +171,21 @@ public interface ClassWriter {
|
|||||||
*/
|
*/
|
||||||
Content getMemberTreeHeader();
|
Content getMemberTreeHeader();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a list to be used for the list of details for members of a given kind.
|
||||||
|
*
|
||||||
|
* @return a list to be used for the list of details for members of a given kind
|
||||||
|
*/
|
||||||
|
Content getDetailsList();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an item for the list of details for members of a given kind.
|
||||||
|
*
|
||||||
|
* @param content content for the item
|
||||||
|
* @return an item for the list of details for members of a given kind
|
||||||
|
*/
|
||||||
|
Content getDetailsListItem(Content content);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add the class content tree.
|
* Add the class content tree.
|
||||||
*
|
*
|
||||||
|
@ -78,7 +78,7 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
|
|||||||
AnnotationTypeRequiredMemberWriter writer,
|
AnnotationTypeRequiredMemberWriter writer,
|
||||||
VisibleMemberTable.Kind memberType) {
|
VisibleMemberTable.Kind memberType) {
|
||||||
super(context, typeElement);
|
super(context, typeElement);
|
||||||
this.writer = writer;
|
this.writer = Objects.requireNonNull(writer);
|
||||||
this.members = getVisibleMembers(memberType);
|
this.members = getVisibleMembers(memberType);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -126,16 +126,13 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
|
|||||||
/**
|
/**
|
||||||
* Build the member documentation.
|
* Build the member documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if an error occurs
|
* @throws DocletException if an error occurs
|
||||||
*/
|
*/
|
||||||
protected void buildAnnotationTypeMember(Content memberDetailsTree)
|
protected void buildAnnotationTypeMember(Content detailsList)
|
||||||
throws DocletException {
|
throws DocletException {
|
||||||
if (writer == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (hasMembersToDocument()) {
|
if (hasMembersToDocument()) {
|
||||||
writer.addAnnotationDetailsMarker(memberDetailsTree);
|
writer.addAnnotationDetailsMarker(detailsList);
|
||||||
Content annotationDetailsTreeHeader = writer.getAnnotationDetailsTreeHeader();
|
Content annotationDetailsTreeHeader = writer.getAnnotationDetailsTreeHeader();
|
||||||
Content memberList = writer.getMemberList();
|
Content memberList = writer.getMemberList();
|
||||||
|
|
||||||
@ -147,7 +144,8 @@ public class AnnotationTypeRequiredMemberBuilder extends AbstractMemberBuilder {
|
|||||||
|
|
||||||
memberList.add(writer.getMemberListItem(annotationDocTree));
|
memberList.add(writer.getMemberListItem(annotationDocTree));
|
||||||
}
|
}
|
||||||
memberDetailsTree.add(writer.getAnnotationDetails(annotationDetailsTreeHeader, memberList));
|
Content annotationDetails = writer.getAnnotationDetails(annotationDetailsTreeHeader, memberList);
|
||||||
|
detailsList.add(annotationDetails);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -335,67 +335,67 @@ public class ClassBuilder extends AbstractBuilder {
|
|||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildMemberDetails(Content classContentTree) throws DocletException {
|
protected void buildMemberDetails(Content classContentTree) throws DocletException {
|
||||||
Content memberDetailsTree = writer.getMemberTreeHeader();
|
Content detailsList = writer.getDetailsList();
|
||||||
|
|
||||||
buildEnumConstantsDetails(memberDetailsTree);
|
buildEnumConstantsDetails(detailsList);
|
||||||
buildPropertyDetails(memberDetailsTree);
|
buildPropertyDetails(detailsList);
|
||||||
buildFieldDetails(memberDetailsTree);
|
buildFieldDetails(detailsList);
|
||||||
buildConstructorDetails(memberDetailsTree);
|
buildConstructorDetails(detailsList);
|
||||||
buildAnnotationTypeRequiredMemberDetails(memberDetailsTree);
|
buildAnnotationTypeRequiredMemberDetails(detailsList);
|
||||||
buildAnnotationTypeOptionalMemberDetails(memberDetailsTree);
|
buildAnnotationTypeOptionalMemberDetails(detailsList);
|
||||||
buildMethodDetails(memberDetailsTree);
|
buildMethodDetails(detailsList);
|
||||||
|
|
||||||
classContentTree.add(writer.getMemberDetailsTree(memberDetailsTree));
|
classContentTree.add(writer.getMemberDetailsTree(detailsList));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build the enum constants documentation.
|
* Build the enum constants documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildEnumConstantsDetails(Content memberDetailsTree) throws DocletException {
|
protected void buildEnumConstantsDetails(Content detailsList) throws DocletException {
|
||||||
builderFactory.getEnumConstantsBuilder(writer).build(memberDetailsTree);
|
builderFactory.getEnumConstantsBuilder(writer).build(detailsList);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build the field documentation.
|
* Build the field documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildFieldDetails(Content memberDetailsTree) throws DocletException {
|
protected void buildFieldDetails(Content detailsList) throws DocletException {
|
||||||
builderFactory.getFieldBuilder(writer).build(memberDetailsTree);
|
builderFactory.getFieldBuilder(writer).build(detailsList);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build the property documentation.
|
* Build the property documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
public void buildPropertyDetails( Content memberDetailsTree) throws DocletException {
|
public void buildPropertyDetails( Content detailsList) throws DocletException {
|
||||||
builderFactory.getPropertyBuilder(writer).build(memberDetailsTree);
|
builderFactory.getPropertyBuilder(writer).build(detailsList);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build the constructor documentation.
|
* Build the constructor documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildConstructorDetails(Content memberDetailsTree) throws DocletException {
|
protected void buildConstructorDetails(Content detailsList) throws DocletException {
|
||||||
builderFactory.getConstructorBuilder(writer).build(memberDetailsTree);
|
builderFactory.getConstructorBuilder(writer).build(detailsList);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build the method documentation.
|
* Build the method documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildMethodDetails(Content memberDetailsTree) throws DocletException {
|
protected void buildMethodDetails(Content detailsList) throws DocletException {
|
||||||
builderFactory.getMethodBuilder(writer).build(memberDetailsTree);
|
builderFactory.getMethodBuilder(writer).build(detailsList);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -74,7 +74,7 @@ public class ConstructorBuilder extends AbstractMemberBuilder {
|
|||||||
TypeElement typeElement,
|
TypeElement typeElement,
|
||||||
ConstructorWriter writer) {
|
ConstructorWriter writer) {
|
||||||
super(context, typeElement);
|
super(context, typeElement);
|
||||||
this.writer = writer;
|
this.writer = Objects.requireNonNull(writer);
|
||||||
constructors = getVisibleMembers(CONSTRUCTORS);
|
constructors = getVisibleMembers(CONSTRUCTORS);
|
||||||
for (Element ctor : constructors) {
|
for (Element ctor : constructors) {
|
||||||
if (utils.isProtected(ctor) || utils.isPrivate(ctor)) {
|
if (utils.isProtected(ctor) || utils.isPrivate(ctor)) {
|
||||||
@ -118,15 +118,12 @@ public class ConstructorBuilder extends AbstractMemberBuilder {
|
|||||||
/**
|
/**
|
||||||
* Build the constructor documentation.
|
* Build the constructor documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildConstructorDoc(Content memberDetailsTree) throws DocletException {
|
protected void buildConstructorDoc(Content detailsList) throws DocletException {
|
||||||
if (writer == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (hasMembersToDocument()) {
|
if (hasMembersToDocument()) {
|
||||||
Content constructorDetailsTreeHeader = writer.getConstructorDetailsTreeHeader(memberDetailsTree);
|
Content constructorDetailsTreeHeader = writer.getConstructorDetailsTreeHeader(detailsList);
|
||||||
Content memberList = writer.getMemberList();
|
Content memberList = writer.getMemberList();
|
||||||
|
|
||||||
for (Element constructor : constructors) {
|
for (Element constructor : constructors) {
|
||||||
@ -140,8 +137,8 @@ public class ConstructorBuilder extends AbstractMemberBuilder {
|
|||||||
|
|
||||||
memberList.add(writer.getMemberListItem(constructorDocTree));
|
memberList.add(writer.getMemberListItem(constructorDocTree));
|
||||||
}
|
}
|
||||||
memberDetailsTree.add(
|
Content constructorDetails = writer.getConstructorDetails(constructorDetailsTreeHeader, memberList);
|
||||||
writer.getConstructorDetails(constructorDetailsTreeHeader, memberList));
|
detailsList.add(constructorDetails);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -74,7 +74,7 @@ public class EnumConstantBuilder extends AbstractMemberBuilder {
|
|||||||
private EnumConstantBuilder(Context context,
|
private EnumConstantBuilder(Context context,
|
||||||
TypeElement typeElement, EnumConstantWriter writer) {
|
TypeElement typeElement, EnumConstantWriter writer) {
|
||||||
super(context, typeElement);
|
super(context, typeElement);
|
||||||
this.writer = writer;
|
this.writer = Objects.requireNonNull(writer);
|
||||||
enumConstants = getVisibleMembers(ENUM_CONSTANTS);
|
enumConstants = getVisibleMembers(ENUM_CONSTANTS);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -109,16 +109,13 @@ public class EnumConstantBuilder extends AbstractMemberBuilder {
|
|||||||
/**
|
/**
|
||||||
* Build the enum constant documentation.
|
* Build the enum constant documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException is there is a problem while building the documentation
|
* @throws DocletException is there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildEnumConstant(Content memberDetailsTree) throws DocletException {
|
protected void buildEnumConstant(Content detailsList) throws DocletException {
|
||||||
if (writer == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (hasMembersToDocument()) {
|
if (hasMembersToDocument()) {
|
||||||
Content enumConstantsDetailsTreeHeader = writer.getEnumConstantsDetailsTreeHeader(typeElement,
|
Content enumConstantsDetailsTreeHeader = writer.getEnumConstantsDetailsTreeHeader(typeElement,
|
||||||
memberDetailsTree);
|
detailsList);
|
||||||
Content memberList = writer.getMemberList();
|
Content memberList = writer.getMemberList();
|
||||||
|
|
||||||
for (Element enumConstant : enumConstants) {
|
for (Element enumConstant : enumConstants) {
|
||||||
@ -133,8 +130,9 @@ public class EnumConstantBuilder extends AbstractMemberBuilder {
|
|||||||
|
|
||||||
memberList.add(writer.getMemberListItem(enumConstantsTree));
|
memberList.add(writer.getMemberListItem(enumConstantsTree));
|
||||||
}
|
}
|
||||||
memberDetailsTree.add(
|
Content enumConstantDetails = writer.getEnumConstantsDetails(
|
||||||
writer.getEnumConstantsDetails(enumConstantsDetailsTreeHeader, memberList));
|
enumConstantsDetailsTreeHeader, memberList);
|
||||||
|
detailsList.add(enumConstantDetails);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ public class FieldBuilder extends AbstractMemberBuilder {
|
|||||||
TypeElement typeElement,
|
TypeElement typeElement,
|
||||||
FieldWriter writer) {
|
FieldWriter writer) {
|
||||||
super(context, typeElement);
|
super(context, typeElement);
|
||||||
this.writer = writer;
|
this.writer = Objects.requireNonNull(writer);
|
||||||
fields = getVisibleMembers(FIELDS);
|
fields = getVisibleMembers(FIELDS);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -111,15 +111,12 @@ public class FieldBuilder extends AbstractMemberBuilder {
|
|||||||
/**
|
/**
|
||||||
* Build the field documentation.
|
* Build the field documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildFieldDoc(Content memberDetailsTree) throws DocletException {
|
protected void buildFieldDoc(Content detailsList) throws DocletException {
|
||||||
if (writer == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!fields.isEmpty()) {
|
if (!fields.isEmpty()) {
|
||||||
Content fieldDetailsTreeHeader = writer.getFieldDetailsTreeHeader(memberDetailsTree);
|
Content fieldDetailsTreeHeader = writer.getFieldDetailsTreeHeader(detailsList);
|
||||||
Content memberList = writer.getMemberList();
|
Content memberList = writer.getMemberList();
|
||||||
|
|
||||||
for (Element element : fields) {
|
for (Element element : fields) {
|
||||||
@ -133,8 +130,8 @@ public class FieldBuilder extends AbstractMemberBuilder {
|
|||||||
|
|
||||||
memberList.add(writer.getMemberListItem(fieldDocTree));
|
memberList.add(writer.getMemberListItem(fieldDocTree));
|
||||||
}
|
}
|
||||||
memberDetailsTree.add(
|
Content fieldDetails = writer.getFieldDetails(fieldDetailsTreeHeader, memberList);
|
||||||
writer.getFieldDetails(fieldDetailsTreeHeader, memberList));
|
detailsList.add(fieldDetails);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -78,7 +78,7 @@ public class MethodBuilder extends AbstractMemberBuilder {
|
|||||||
TypeElement typeElement,
|
TypeElement typeElement,
|
||||||
MethodWriter writer) {
|
MethodWriter writer) {
|
||||||
super(context, typeElement);
|
super(context, typeElement);
|
||||||
this.writer = writer;
|
this.writer = Objects.requireNonNull(writer);
|
||||||
methods = getVisibleMembers(METHODS);
|
methods = getVisibleMembers(METHODS);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -109,15 +109,12 @@ public class MethodBuilder extends AbstractMemberBuilder {
|
|||||||
/**
|
/**
|
||||||
* Build the method documentation.
|
* Build the method documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildMethodDoc(Content memberDetailsTree) throws DocletException {
|
protected void buildMethodDoc(Content detailsList) throws DocletException {
|
||||||
if (writer == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (hasMembersToDocument()) {
|
if (hasMembersToDocument()) {
|
||||||
Content methodDetailsTreeHeader = writer.getMethodDetailsTreeHeader(memberDetailsTree);
|
Content methodDetailsTreeHeader = writer.getMethodDetailsTreeHeader(detailsList);
|
||||||
Content memberList = writer.getMemberList();
|
Content memberList = writer.getMemberList();
|
||||||
|
|
||||||
for (Element method : methods) {
|
for (Element method : methods) {
|
||||||
@ -131,7 +128,8 @@ public class MethodBuilder extends AbstractMemberBuilder {
|
|||||||
|
|
||||||
memberList.add(writer.getMemberListItem(methodDocTree));
|
memberList.add(writer.getMemberListItem(methodDocTree));
|
||||||
}
|
}
|
||||||
memberDetailsTree.add(writer.getMethodDetails(methodDetailsTreeHeader, memberList));
|
Content methodDetails = writer.getMethodDetails(methodDetailsTreeHeader, memberList);
|
||||||
|
detailsList.add(methodDetails);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -75,7 +75,7 @@ public class PropertyBuilder extends AbstractMemberBuilder {
|
|||||||
TypeElement typeElement,
|
TypeElement typeElement,
|
||||||
PropertyWriter writer) {
|
PropertyWriter writer) {
|
||||||
super(context, typeElement);
|
super(context, typeElement);
|
||||||
this.writer = writer;
|
this.writer = Objects.requireNonNull(writer);
|
||||||
properties = getVisibleMembers(PROPERTIES);
|
properties = getVisibleMembers(PROPERTIES);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -111,15 +111,12 @@ public class PropertyBuilder extends AbstractMemberBuilder {
|
|||||||
/**
|
/**
|
||||||
* Build the property documentation.
|
* Build the property documentation.
|
||||||
*
|
*
|
||||||
* @param memberDetailsTree the content tree to which the documentation will be added
|
* @param detailsList the content tree to which the documentation will be added
|
||||||
* @throws DocletException if there is a problem while building the documentation
|
* @throws DocletException if there is a problem while building the documentation
|
||||||
*/
|
*/
|
||||||
protected void buildPropertyDoc(Content memberDetailsTree) throws DocletException {
|
protected void buildPropertyDoc(Content detailsList) throws DocletException {
|
||||||
if (writer == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (hasMembersToDocument()) {
|
if (hasMembersToDocument()) {
|
||||||
Content propertyDetailsTreeHeader = writer.getPropertyDetailsTreeHeader(memberDetailsTree);
|
Content propertyDetailsTreeHeader = writer.getPropertyDetailsTreeHeader(detailsList);
|
||||||
Content memberList = writer.getMemberList();
|
Content memberList = writer.getMemberList();
|
||||||
|
|
||||||
for (Element property : properties) {
|
for (Element property : properties) {
|
||||||
@ -132,8 +129,8 @@ public class PropertyBuilder extends AbstractMemberBuilder {
|
|||||||
|
|
||||||
memberList.add(writer.getMemberListItem(propertyDocTree));
|
memberList.add(writer.getMemberListItem(propertyDocTree));
|
||||||
}
|
}
|
||||||
memberDetailsTree.add(
|
Content propertyDetails = writer.getPropertyDetails(propertyDetailsTreeHeader, memberList);
|
||||||
writer.getPropertyDetails(propertyDetailsTreeHeader, memberList));
|
detailsList.add(propertyDetails);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -321,11 +321,11 @@ div.inheritance {
|
|||||||
div.inheritance div.inheritance {
|
div.inheritance div.inheritance {
|
||||||
margin-left:2em;
|
margin-left:2em;
|
||||||
}
|
}
|
||||||
ul.block-list, ul.member-list {
|
ul.block-list, ul.details-list, ul.member-list {
|
||||||
margin:10px 0 10px 0;
|
margin:10px 0 10px 0;
|
||||||
padding:0;
|
padding:0;
|
||||||
}
|
}
|
||||||
ul.block-list > li, ul.member-list > li {
|
ul.block-list > li, ul.details-list > li, ul.member-list > li {
|
||||||
list-style:none;
|
list-style:none;
|
||||||
margin-bottom:15px;
|
margin-bottom:15px;
|
||||||
line-height:1.4;
|
line-height:1.4;
|
||||||
|
@ -394,7 +394,7 @@ public class TestHtmlVersion extends JavadocTester {
|
|||||||
+ "<h2>Optional Element Summary</h2>\n"
|
+ "<h2>Optional Element Summary</h2>\n"
|
||||||
+ "<div class=\"member-summary\">\n<table>",
|
+ "<div class=\"member-summary\">\n<table>",
|
||||||
"<section class=\"details\" id=\"annotation.type.element.detail\">\n"
|
"<section class=\"details\" id=\"annotation.type.element.detail\">\n"
|
||||||
+ "<ul class=\"block-list\">\n"
|
+ "<ul class=\"details-list\">\n"
|
||||||
+ "<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->\n"
|
+ "<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->\n"
|
||||||
+ "<li>\n"
|
+ "<li>\n"
|
||||||
+ "<section class=\"member-details\">\n"
|
+ "<section class=\"member-details\">\n"
|
||||||
|
@ -23,8 +23,8 @@
|
|||||||
|
|
||||||
/*
|
/*
|
||||||
* @test
|
* @test
|
||||||
* @bug 8241625
|
* @bug 8241625 8241895
|
||||||
* @summary test the lists genereated by the doclet
|
* @summary test the lists generated by the doclet
|
||||||
* @library /tools/lib ../../lib
|
* @library /tools/lib ../../lib
|
||||||
* @modules jdk.javadoc/jdk.javadoc.internal.tool
|
* @modules jdk.javadoc/jdk.javadoc.internal.tool
|
||||||
* @build toolbox.ToolBox javadoc.tester.*
|
* @build toolbox.ToolBox javadoc.tester.*
|
||||||
@ -97,4 +97,60 @@ public class TestLists extends JavadocTester {
|
|||||||
+ "<li>\n"
|
+ "<li>\n"
|
||||||
+ "<section class=\"detail\" id=\"value()\">");
|
+ "<section class=\"detail\" id=\"value()\">");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
public void testDetailLists(Path base) throws IOException {
|
||||||
|
Path src = base.resolve("src");
|
||||||
|
tb.writeJavaFiles(src,
|
||||||
|
"package p; public class C {\n"
|
||||||
|
+ " public C() { }\n"
|
||||||
|
+ " public C(int i) { }\n"
|
||||||
|
+ " public int f1;\n"
|
||||||
|
+ " public int f2;\n"
|
||||||
|
+ " public void m1() { }\n"
|
||||||
|
+ " public void m2() { }\n"
|
||||||
|
+ "}\n",
|
||||||
|
"package p; public enum E { E1, E2 }\n",
|
||||||
|
"package p; public @interface A { int value(); }\n"
|
||||||
|
);
|
||||||
|
|
||||||
|
javadoc("-d", base.resolve("out").toString(),
|
||||||
|
"-sourcepath", src.toString(),
|
||||||
|
"p");
|
||||||
|
checkExit(Exit.OK);
|
||||||
|
|
||||||
|
checkOutput("p/C.html", true,
|
||||||
|
"<section class=\"details\">\n"
|
||||||
|
+ "<ul class=\"details-list\">\n"
|
||||||
|
+ "<!-- ============ FIELD DETAIL =========== -->\n"
|
||||||
|
+ "<li>\n"
|
||||||
|
+ "<section class=\"field-details\" id=\"field.detail\">\n"
|
||||||
|
+ "<h2>Field Details</h2>\n"
|
||||||
|
+ "<ul class=\"member-list\">",
|
||||||
|
"</ul>\n"
|
||||||
|
+ "</section>\n"
|
||||||
|
+ "</li>\n"
|
||||||
|
+ "<!-- ========= CONSTRUCTOR DETAIL ======== -->\n"
|
||||||
|
+ "<li>\n"
|
||||||
|
+ "<section class=\"constructor-details\" id=\"constructor.detail\">\n"
|
||||||
|
+ "<h2>Constructor Details</h2>\n"
|
||||||
|
+ "<ul class=\"member-list\">");
|
||||||
|
|
||||||
|
checkOutput("p/E.html", true,
|
||||||
|
"<section class=\"details\">\n"
|
||||||
|
+ "<ul class=\"details-list\">\n"
|
||||||
|
+ "<!-- ============ ENUM CONSTANT DETAIL =========== -->\n"
|
||||||
|
+ "<li>\n"
|
||||||
|
+ "<section class=\"constant-details\" id=\"enum.constant.detail\">\n"
|
||||||
|
+ "<h2>Enum Constant Details</h2>\n"
|
||||||
|
+ "<ul class=\"member-list\">");
|
||||||
|
|
||||||
|
checkOutput("p/A.html", true,
|
||||||
|
"<ul class=\"details-list\">\n"
|
||||||
|
+ "<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->\n"
|
||||||
|
+ "<li>\n"
|
||||||
|
+ "<section class=\"member-details\">\n"
|
||||||
|
+ "<h2>Element Details</h2>\n"
|
||||||
|
+ "<ul class=\"member-list\">");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user