-
Type:
Enhancement
-
Resolution: Fixed
-
Priority:
P3
-
Affects Version/s: None
-
Component/s: tools
-
b10
There are situations that may benefit from the introduction of an escape-character mechanism to workaround undesirable existing behavior.
Some of these situations are exacerbated if using Markdown syntax in comments, although not inherently so.
There are 3 known situations.
1. To inhibit the use of `@` to introduce a block tag or inline tag.
2. To allow a line to begin with `whitespace asterisk` when that sequence might otherwise by ignored when obtaining the content of a doc comment
3. To allow writing `*/`, to avoid that sequence ending the enclosing comment.
Some of these situations are exacerbated if using Markdown syntax in comments, although not inherently so.
There are 3 known situations.
1. To inhibit the use of `@` to introduce a block tag or inline tag.
2. To allow a line to begin with `whitespace asterisk` when that sequence might otherwise by ignored when obtaining the content of a doc comment
3. To allow writing `*/`, to avoid that sequence ending the enclosing comment.
- csr for
-
JDK-8301294 Allow `@` as an escape in documentation comments
-
- Closed
-
- relates to
-
JDK-8301810 Bug in doctree DocCommentTester.compress
-
- Resolved
-
-
-
- Resolved
-
-
-
- Resolved
-
(1 links to)