On Mon, 8 May 2023 12:15:57 GMT, Raffaello Giulietti <rgiulie...@openjdk.org> 
wrote:

>> The HTML named entity `&centerdot;` is rendered correctly by the javadoc 
>> tool. However, IntelliJ IDEA currently does not recognize it 
>> (https://youtrack.jetbrains.com/issue/IDEA-316843). I could replace it by 
>> the equivalent `&#xB7;`, which is recognized by IDEA, but which is much less 
>> readable in source code.
>> So, unless there are other reason to prefer `*`, I'd like to stick with 
>> `&centerdot;`.
>> 
>> WDYT?
>
> Alternatively, one could remove the multiplication sign altogether...

> I could replace it by the equivalent `&#xB7;`

I just locally used this as a replacement to `centerdot` and regenerated the 
javadocs. The generated javadoc HTML looks the same like the screenshot in my 
previous comment.

My only concern here is that this notation isn't used previously in any of our 
APIs and since it's part of a "regular" (non mathemical) sentence, it might be 
hard to understand what it is. I think it is relatable when it's part of some 
larger mathematical formula/explanation.

I just did a quick search of `centerdot` in the JDK source to see if it's been 
used in any API documentation currently and didn't find any such cases. So I 
still think using `*` would be clearer.

Having said that, if there are no objections from Roger or any other reviewers, 
it's OK with me too.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/13305#discussion_r1187380898

Reply via email to