-
Enhancement
-
Resolution: Fixed
-
P3
-
19
-
b11
It would be good to ensure that all HTML headings (<hN>...</hN) in user-defined doc comments have an id, so that the heading can be the target of a link.
This suggests providing an id when there is none, perhaps by using an algorithm similar to that used in pandoc/markdown: change letters to lower case and replace sequences of non-identifier characters with a hyphen.
We might want an encoding that prevents accidental clashes with existing ids, such as those that may be generated for field names. It may be enough to ensure that there is at least one hyphen. We should also ensure no clashes with other standard ids, such as those defined internally in `HtmlIds`.
Overall, this would interact well with the ability to copy a URL to the clipboard.JDK-8277420
This suggests providing an id when there is none, perhaps by using an algorithm similar to that used in pandoc/markdown: change letters to lower case and replace sequences of non-identifier characters with a hyphen.
We might want an encoding that prevents accidental clashes with existing ids, such as those that may be generated for field names. It may be enough to ensure that there is at least one hyphen. We should also ensure no clashes with other standard ids, such as those defined internally in `HtmlIds`.
Overall, this would interact well with the ability to copy a URL to the clipboard.
- is blocked by
-
JDK-8288699 cleanup HTML tree in HtmlDocletWriter.commentTagsToContent
- Resolved
- relates to
-
JDK-8200337 Generalize see and link tags for user-defined anchors
- Resolved
-
JDK-8277420 Provide a way to copy the hyperlink to a doc element to the clipboard
- Resolved
-
JDK-8305958 Use links instead of buttons for auto-generated header links
- Resolved
(1 links to)
There are no Sub-Tasks for this issue.