Skip to content

Fix rendering for different IDE versions #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 4, 2022
Merged

Fix rendering for different IDE versions #1087

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9dc9370
Fix rendering for different IDE versions
onewhl Oct 4, 2022
f357bba
add info about IDE version for each case
onewhl Oct 4, 2022
8f5e364
Merge branch 'main' into zarina/1078_rendering
onewhl Oct 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/javadoc/UtDocumentationProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,20 @@ class UtDocumentationProvider : JavaDocumentationProvider() {
docComment: PsiDocComment,
comment: PsiDocCommentBase
): String? {
// add UTBot sections with custom tags.
val utJavaDocInfoGenerator = UtJavaDocInfoGenerator()
return if (baseJavaDocInfo != null && baseJavaDocInfo.contains("utbot")) {
// case 1 (2022.2): IDE successfully parsed comment with plugin's custom tags,
// and we only need to replace tags names with their messages.
return if (baseJavaDocInfo != null && baseJavaDocInfo.contains("@utbot")) {
val finalJavaDoc = replaceTagNamesWithMessages(baseJavaDocInfo)
JavaDocExternalFilter.filterInternalDocInfo(finalJavaDoc)
// case 2 (2022.1 and older): IDE failed to parse plugin's tags, and we need to add them on our own.
} else if (baseJavaDocInfo != null && comment.text.contains("@utbot")) {
val javaDocInfoWithUtSections =
utJavaDocInfoGenerator.addUtBotSpecificSectionsToJavaDoc(docComment)
val finalJavaDoc = replaceTagNamesWithMessages(javaDocInfoWithUtSections)
JavaDocExternalFilter.filterInternalDocInfo(finalJavaDoc)
} else {
// case 3: comment doesn't contain plugin's tags, so IDE can parse it on its own.
super.generateRenderedDoc(comment)
}
}
Expand Down