fix: Use real name of the tag if it is unknwon #3513
Conversation
Given the scenario that we need to show javadoc comment on LSIF hover, we need realname of the tag instead of UNKNOWN tag
Retain real name when parsing javadoc comment, and pretty print the realname tag instead of using UNKNOWN
|
Forgive me for mistakes on code modification. Recently I don't have much time on fixing failed test cases, I will perfect it as soon as possible. |
| @@ -151,7 +151,7 @@ public void testGenerateCloneVisitor() { | |||
| CtClass<Object> expected = build(new File("./src/main/java/spoon/support/visitor/clone/CloneBuilder.java")).Class().get("spoon.support.visitor.clone.CloneBuilder"); | |||
| assertThat(actual).isEqualTo(expected); | |||
|
|
|||
| // cp ./target/generated/spoon/support/visitor/clone/CloneVisitor.java ./src/main/java/spoon/support/visitor/clone/CloneVisitor.java | |||
…own type match problem tag name is UNKNOWN, but TagType.UNKNOWN.getName() is unknwon, should compare ignore case
… feature/real_name_tag
|
Hi @zxdxjtu Thanks for the ping. I don't see new changes in the diff since my previous review: #3513 (review) Any idea? |
|
FYI, this stackoverflow question seems about this: https://stackoverflow.com/questions/63810364/getting-text-of-non-javadoc-tag-inside-doc-comment |
|
Hi @zxdxjtu we're almost there, one more change and failing tests to fox :) Then we merge! |
|
Hi, @monperrus , it seems that I have already fixed all travis issues before, but 'travis failed' appeared again when I merged master. Travis said multiple ' duplicate classes found', I am not so familiar with travis, could you help me find the way to fix travis issue? |
monperrus
changed the title
|
Thanks a lot for your contribution! |
When generating LSIF file using spoon, we use (CtClass)ctClass.getDocComment to fetch doc comment of the class to display hover result.
However, spoon regards user-defined tag (e.g. @email @create ) as '@unknown', it is really unfriendly for printing hover content. Usually the class hover would be:
Example class
@author zxdxjtu
@unknwon [email protected]
@unknown 2020-07-30 10:24
To solve this problem, I retain the real name of the comment tag and use real name of the rag instead of TagType.name when printing doc comment to avoid '@unknown' condition.