feat(living-docs): add parameter and return tag instructions

Add parameter and return tag instructions to LivingDocumentation classes for Kotlin and Java providers.

This commit updates the Kotlin and Java LivingDocumentation classes to include instructions for using @param and @return tags. The instructions are now accessible through the parameterTagInstruction and returnTagInstruction properties.

Author: phodal

java/src/main/kotlin/cc/unitmesh/idea/provider/JavaLivingDocumentation.kt

@@ -12,6 +12,9 @@ import com.intellij.psi.util.PsiTreeUtil
 import com.intellij.util.IncorrectOperationException
 
 class JavaLivingDocumentation : LivingDocumentation {
+    override val parameterTagInstruction: String get() = "use @param tag"
+    override val returnTagInstruction: String get() = "use @return tag"
+
     override val forbiddenRules: List<String> = listOf(
         "do not return example code",
         "do not use @author and @version tags"

kotlin/src/main/kotlin/cc/unitmesh/kotlin/provider/KotlinLivingDocumentation.kt

@@ -53,6 +53,9 @@ import org.jetbrains.kotlin.psi.KtNamedFunction
  * @see LivingDocumentationType
  */
 class KotlinLivingDocumentation : LivingDocumentation {
+    override val parameterTagInstruction: String get() = "use @param tag"
+    override val returnTagInstruction: String get() = "use @return tag"
+
     companion object {
         private val logger = logger<KotlinLivingDocumentation>()
     }

src/main/kotlin/cc/unitmesh/devti/intentions/action/task/LivingDocPromptBuilder.kt

@@ -74,15 +74,15 @@ open class LivingDocPromptBuilder(
         if (context.paramNames.isNotEmpty()) {
             instruction = """
                 $instruction
-                ${documentation.parameterTagInstruction}
+                ${documentation.parameterTagInstruction ?: ""}
                 """.trimIndent()
         }
 
         val returnType = context.returnType
         if (!returnType.isNullOrEmpty()) {
             instruction = """
                 $instruction
-                ${documentation.returnTagInstruction}
+                ${documentation.returnTagInstruction ?: ""}
                 """.trimIndent()
         }
 

src/main/kotlin/cc/unitmesh/devti/provider/LivingDocumentation.kt

@@ -17,8 +17,8 @@ import com.intellij.psi.PsiNameIdentifierOwner
 interface LivingDocumentation {
     val forbiddenRules: List<String>
 
-    val parameterTagInstruction: String get() = "use @param tag"
-    val returnTagInstruction: String get() = "use @return tag"
+    val parameterTagInstruction: String? get() = null
+    val returnTagInstruction: String? get() = null
 
     fun startEndString(type: LivingDocumentationType): Pair<String, String>