docs: some comment and @Notnull

This commit is contained in:
林万程
2024-07-28 23:16:51 +08:00
parent e60ad5722e
commit 49f8a602bf
3 changed files with 10 additions and 4 deletions

View File

@@ -67,7 +67,7 @@ public class ScalaLangDoc extends JavaLangDoc {
@Override
protected <T extends SettingsInfo> void appendTag(@NotNull T info, @NotNull StringBuilder tagStrBuilder,
@NotNull PsiDocComment psiDocComment, @NotNull String name) {
String key = "@" + name;
@NotNull String key = "@" + name;
@NotNull PsiDocTag[] tags = psiDocComment.findTagsByName(key);
for (@NotNull PsiDocTag tag : tags) {
if (tag instanceof ScDocTag) {

View File

@@ -104,6 +104,7 @@ public abstract class BaseLangDoc extends EditorLinePainter {
}
/**
* skip english and text
* Override like SQL
*/
@Nullable
@@ -146,6 +147,9 @@ public abstract class BaseLangDoc extends EditorLinePainter {
return null;
}
/**
* static! byte to src, by language
*/
public static @Nullable <T extends SettingsInfo> String resolveDoc(@NotNull T info,
@NotNull PsiElement psiElement) {
try {
@@ -166,6 +170,7 @@ public abstract class BaseLangDoc extends EditorLinePainter {
}
/**
* line and delete /*#, filter by pattern
* Override like Java/Kotlin/Python
*/
@Nullable
@@ -183,6 +188,7 @@ public abstract class BaseLangDoc extends EditorLinePainter {
}
/**
* LineEnd and LineUp
* Override like JS/Go
*/
@Nullable

View File

@@ -20,9 +20,9 @@ public class DocFilter {
"|^ */\\*++ *+" +
// ****/ xx block end, not only line start and must before ****
"| *\\*++/.*" +
// **** xx block body
// **** xx block body
"|^ *\\*++ *+" +
// #### xx python and shell start
// #### xx python and sh start
"|^ *#++ *+" +
// -- xx SQL
"|^ *--++ *+"
@@ -31,7 +31,7 @@ public class DocFilter {
private static final Pattern LINE_SEPARATOR_PATTERN = Pattern.compile("[\r\n]");
/**
* delete / * # in resolveDocPrint()
* line and delete /*# in resolveDocPrint()
* end with space
*/
@NotNull