-
Bug
-
Resolution: Fixed
-
P3
-
19
-
b09
HtmlDocletWriter contains a non-trivial method, `seeTagToContent`, to handle `@see` and `{@link...}` tags, converting them to `Content`.
This is strange in two ways:
1. The method handles both kinds of tags. While there is a lot of commonality in the handling of `{@link...}` and one of the forms of `@see`, the latter has additional forms that are not related to `{@link...}`. This suggests splitting the method into two "front-end" methods and a shared "back-end" method to handle the case of a `ReferenceTree`, which is the shared common case.
2. The "standard" place for code to translate tags to `Content` is `TagletWriter[Impl]`. This suggests the overall functionality of `seeTagToContent` should be in `TagletWriterImpl`, possibly with appropriate interface methods defined in `TagletWriter`.
This is strange in two ways:
1. The method handles both kinds of tags. While there is a lot of commonality in the handling of `{@link...}` and one of the forms of `@see`, the latter has additional forms that are not related to `{@link...}`. This suggests splitting the method into two "front-end" methods and a shared "back-end" method to handle the case of a `ReferenceTree`, which is the shared common case.
2. The "standard" place for code to translate tags to `Content` is `TagletWriter[Impl]`. This suggests the overall functionality of `seeTagToContent` should be in `TagletWriterImpl`, possibly with appropriate interface methods defined in `TagletWriter`.
- blocks
-
JDK-8290330 Show type signature of parameterized types
-
- Closed
-
- duplicates
-
JDK-8273721 Make the HtmlDocletWriter.seeTagToContent functionality reusable
-
- Closed
-
- is blocked by
-
JDK-8281969 Bad result for the snippet @link tag if substring/regex consists of whitespace
-
- Resolved
-