RFR: JDK-8242607 -Xdoclint doesn't report missing/unexpected comments

Jonathan Gibbons jonathan.gibbons at oracle.com
Wed Jun 10 15:37:52 UTC 2020


On 6/10/20 7:54 AM, Kumar Srinivasan wrote:
>>
>> I'd also like the review the use of 3 separate maps to get doc 
>> comment info from elements:
>> there's one down in com.sun.source world, one in CommentUtils and 
>> another in Utils.
>>
>>
>
> I agree, this needs to be looked at, it was quite a task to get rid of 
> the old DocComment structures.
> I think consolidating Utils and CommentUtils should be doable, since 
> it will be local to the doclet.
>
> Kumar


As a general comment, we're looking to partition Utils into smaller more 
specific components, such as the recent Comparators class. So at that 
level, I would not want to merge Utils and CommentUtils.

But, down at a more specific level, I think that moving some of the 
comment-handling stuff from Utils to CommentUtils will be a good move, 
and cleaning up and documenting the code to map and cache 
Element->(TreePath, DocCommentTree) will be a good starting point.

-- Jon



More information about the javadoc-dev mailing list