From 49f8a602bfb1545be3c6e5391a1aebf2e383e2bb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=9E=97=E4=B8=87=E7=A8=8B?= <1498425439@qq.com>
Date: Sun, 28 Jul 2024 23:16:51 +0800
Subject: [PATCH] docs: some comment and @Notnull

---
 .../io/github/linwancen/plugin/show/java/ScalaLangDoc.java  | 2 +-
 .../github/linwancen/plugin/show/lang/base/BaseLangDoc.java | 6 ++++++
 .../github/linwancen/plugin/show/lang/base/DocFilter.java   | 6 +++---
 3 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/src/main/idea/io/github/linwancen/plugin/show/java/ScalaLangDoc.java b/src/main/idea/io/github/linwancen/plugin/show/java/ScalaLangDoc.java
index 4516e88..244f3f0 100644
--- a/src/main/idea/io/github/linwancen/plugin/show/java/ScalaLangDoc.java
+++ b/src/main/idea/io/github/linwancen/plugin/show/java/ScalaLangDoc.java
@@ -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) {
diff --git a/src/main/java/io/github/linwancen/plugin/show/lang/base/BaseLangDoc.java b/src/main/java/io/github/linwancen/plugin/show/lang/base/BaseLangDoc.java
index 1a92c9f..800da0d 100644
--- a/src/main/java/io/github/linwancen/plugin/show/lang/base/BaseLangDoc.java
+++ b/src/main/java/io/github/linwancen/plugin/show/lang/base/BaseLangDoc.java
@@ -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
diff --git a/src/main/java/io/github/linwancen/plugin/show/lang/base/DocFilter.java b/src/main/java/io/github/linwancen/plugin/show/lang/base/DocFilter.java
index eafdf11..7cd9568 100644
--- a/src/main/java/io/github/linwancen/plugin/show/lang/base/DocFilter.java
+++ b/src/main/java/io/github/linwancen/plugin/show/lang/base/DocFilter.java
@@ -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