Merge pull request #23530 from hide212131/fix-multi-line-javadoc-comment

fix jdl multi-line javadoc issue
jhipster · Sep 16, 2023 · b68e3d4 · b68e3d4
2 parents f21f0cb + 77bea9e
commit b68e3d4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/generators/server/support/doc.mjs b/generators/server/support/doc.mjs
@@ -41,7 +41,7 @@ export const formatDocAsJavaDoc = (text, indentSize = 0) => {
   }
   text = escapeDoubleQuotes(text);
   const indent = ' '.repeat(indentSize);
-  const rows = ['/**', ...text.split('/n').map(row => ` * ${row}`), ' */'].map(row => `${indent}${row}`);
+  const rows = ['/**', ...text.split('\\n').map(row => ` * ${row}`), ' */'].map(row => `${indent}${row}`);
   return rows.join('\n');
 };
 

diff --git a/generators/server/support/doc.spec.mts b/generators/server/support/doc.spec.mts
@@ -25,6 +25,12 @@ describe('generator - server - support - doc', () => {
         expect(formatDocAsJavaDoc('Comment="KO"', 1)).toBe(' /**\n  * Comment=\\"KO\\"\n  */');
       });
     });
+    describe('when passing a comment with newlines', () => {
+      it('formats the comment correctly with line breaks', () => {
+        const comment = 'This is the first line.\\nAnd this is the second.';
+        expect(formatDocAsJavaDoc(comment, 1)).toBe(' /**\n  * This is the first line.\n  * And this is the second.\n  */');
+      });
+    });
   });
 
   describe('formatDocAsApiDescription', () => {