fix: solve multiline deprecated description

aliyun · May 21, 2024 · 71a5597 · 71a5597
1 parent e939fa5
commit 71a5597
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 8 deletions.
diff --git a/lib/generator.js b/lib/generator.js
@@ -386,13 +386,21 @@ class Visitor {
     var summaryText = summary ? _escape(summary.text.text.trimEnd()) : '';
     var returnText = _return ? _return.text.text.trimEnd() : '';
     let hasNextSection = false;
-
     if (deprecated) {
-      if (deprecated.text.text.trimEnd() === '') {
-        this.emit(`// Deprecated\n`, level);
-      } else {
-        this.emit(`// Deprecated: ${deprecated.text.text.trimEnd()}\n`, level);
-      }
+      let deprecatedText = deprecated.text.text.trimEnd();
+      deprecatedText.split('\n').forEach((line, index, array) => {
+        if(index === 0) {
+          this.emit(`// Deprecated: ${line}\n`, level);
+          if (array.length > 1) {
+            this.emit(`//\n`, level);
+          }
+        } else {
+          this.emit(`// ${line}\n`, level);
+          if (index < array.length - 1){
+            this.emit(`//\n`, level);
+          }
+        }
+      });
       hasNextSection = true;
     }
     if (summaryText !== '') {

diff --git a/test/fixtures/annotation/client.go b/test/fixtures/annotation/client.go
@@ -115,11 +115,19 @@ func TestFuncWithAnnotation1 (test *string, _test *string) (_err error) {
   return _err
 }
 
+// Deprecated: test is deprecated, use xxx instead.
+//
+// deprecated description1
+//
+// deprecated description2
+// 
 // Summary:
 // 
 // annotation test summary
 // 
-// summary for annotation
+// summary description1
+// 
+// summary description2
 // 
 // @param test - string param1
 // 

diff --git a/test/fixtures/annotation/main.dara b/test/fixtures/annotation/main.dara
@@ -54,7 +54,12 @@ static async function testFuncWithAnnotation1(test: string, _test: string): void
 
 /**
  * @summary annotation test summary
- * summary for annotation
+ * summary description1
+ * summary description2
+ *
+ * @deprecated test is deprecated, use xxx instead.
+ * deprecated description1
+ * deprecated description2
  * 
  * @param test string param1
  * @param _test string param2