Details
-
Bug
-
Resolution: Fixed
-
P4
-
22
-
None
-
b09
Description
Following JDK-8312044 it became clear that there is a lack of reasonable common behavior among groups of related classes.
For example, `HtmlDoclet` caused a number of pages to be generated, but there is no common `generatePage` method. Sure, all the page writers individually implement `build`, but there is no common definition of that method. (Nor was there, in the recently-deleted builder classes; the method was just there "by convention".)
Related, various pages contain "members", but there is no common way that members are handled. Even on the `ClassWriter` page, the summary tables are handled in a very different fashion to the detail lists for each kind of member. In general, the various subtypes of `AbstractMemberWriter` should provide similar methods for the different kinds of member, so that the enclosing page can just iterate over the kinds of `AbstractMemberWriter` to generate the appropriate content. This is done haphazardly, with the result that while some member writers provide the _ability_ to generate kinds of content, the methods are not always invoked. (This was revealed in the work forJDK-8312044, by the IDE reporting that some methods were not called.)
For example, `HtmlDoclet` caused a number of pages to be generated, but there is no common `generatePage` method. Sure, all the page writers individually implement `build`, but there is no common definition of that method. (Nor was there, in the recently-deleted builder classes; the method was just there "by convention".)
Related, various pages contain "members", but there is no common way that members are handled. Even on the `ClassWriter` page, the summary tables are handled in a very different fashion to the detail lists for each kind of member. In general, the various subtypes of `AbstractMemberWriter` should provide similar methods for the different kinds of member, so that the enclosing page can just iterate over the kinds of `AbstractMemberWriter` to generate the appropriate content. This is done haphazardly, with the result that while some member writers provide the _ability_ to generate kinds of content, the methods are not always invoked. (This was revealed in the work for
Attachments
Issue Links
- is blocked by
-
JDK-8313204 Inconsistent order of sections in generated class documentation
-
- Resolved
-
- relates to
-
JDK-8284447 Remove the unused NestedClassWriter interface
-
- Resolved
-
-
JDK-8312044 Simplify toolkit Builder/Writer world
-
- Resolved
-