INRIA / INRIA/spoon

refactor: Javadoc can be managed through JDT

Open
#2,093 2 comments 0 reactions 0 assignees View on GitHub
discussion feature
Dominant language
Java
Stars
2k
Forks
392
Avg merge
11h 24m
Merged PRs (30d)
36

Description

Spoon currently manage all comments the same way, using `JDTCommentBuilder`, even if it's a source code comment or a javadoc comment.

However `JDTCommentBuilder` still have some bugs and is not created to manage - for example - Javadoc `@see` tags related to external types.
On the other hand, JDT which we are using to build the model already gives information about the javadoc and propose its own visitor for that.

So I propose that we move the creation of the Javadoc comment from the JDTCommentBuilder to the JDTTreeBuilder using the JDT visitor. The idea would be then to also get more information from Javadoc elements like the `@see` tags.

WDYT?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.