feat: support java doc

Author: xixiaofinland

src/context.rs

@@ -143,12 +143,78 @@ impl<'a> DocBuild<'a> for Comment {
                 result.push(b.nl());
             }
             CommentType::Block => {
-                let lines: &Vec<&str> = &self.value.split('\n').collect();
-                for (i, line) in lines.iter().enumerate() {
-                    result.push(b.txt(line.trim()));
+                let mut lines: Vec<&str> = self.value.split('\n').collect();
+
+                // JavaDoc formatting
+                if self.value.starts_with("/**") {
+                    // Handle the first line that might contain both /** and content
+                    if !lines.is_empty() {
+                        let first_line = lines[0].trim();
+                        if first_line.len() > 3 {
+                            // Has content after /**
+                            // Extract the content after /**
+                            let content = first_line[3..].trim();
+                            if !content.is_empty() {
+                                // Replace first line with just /**
+                                lines[0] = "/**";
+                                // Insert the content as a new second line
+                                lines.insert(1, content);
+                            }
+                        }
+                    }
+
+                    for (i, line) in lines.iter().enumerate() {
+                        let trimmed = line.trim();
+
+                        if i == 0 {
+                            // First line (/**) remains unchanged
+                            result.push(b.txt(trimmed));
+                        } else if i == lines.len() - 1 {
+                            if let Some(before_end) = trimmed.strip_suffix("*/") {
+                                let content = before_end.trim();
+                                if content.is_empty() {
+                                    result.push(b.txt(" */"));
+                                } else {
+                                    result.push(b.txt(format!(" * {}", content))); // First line: Preserve content
+                                    result.push(b.nl()); // Newline before closing */
+                                    result.push(b.txt(" */")); // Second line: Properly close the comment
+                                }
+                            } else {
+                                result.push(b.txt(" */")); // Fallback (shouldn't happen in valid JavaDoc)
+                            }
+                        } else if trimmed.is_empty() {
+                            // Handle empty lines
+                            result.push(b.txt(" *"));
+                        } else {
+                            // Handle content lines
+                            if let Some(after_star) = trimmed.strip_prefix('*') {
+                                // Line has a star - normalize to exactly one space
+                                let content = after_star.trim_start(); // Remove all leading spaces
+                                if content.is_empty() {
+                                    // Just a star with no content
+                                    result.push(b.txt(" *"));
+                                } else {
+                                    // Star with content - add exactly one space
+                                    result.push(b.txt(format!(" * {}", content)));
+                                }
+                            } else {
+                                // Line doesn't have a star, add standard formatting
+                                result.push(b.txt(format!(" * {}", trimmed)));
+                            }
+                        }
+
+                        if i < lines.len() - 1 {
+                            result.push(b.nl());
+                        }
+                    }
+                } else {
+                    // Regular block comment (non-JavaDoc)
+                    for (i, line) in lines.iter().enumerate() {
+                        result.push(b.txt(line.trim()));
 
-                    if i < lines.len() - 1 {
-                        result.push(b.nl());
+                        if i < lines.len() - 1 {
+                            result.push(b.nl());
+                        }
                     }
                 }
             }

tests/battle_test/hello.cls

@@ -1,20 +1,42 @@
-// format twice will change the format
+/*
+ * This is a
+ * multiline block comment
+ * that is not JavaDoc.
+ */
+
+/** This is a JavaDoc
+with multiple lines
+and some indentation. */
+
+/**
+This is a JavaDoc
+* with inconsistent
+* indentation.
+*/
+
+/**
+ *** This is a JavaDoc
+ *** with excessive asterisks.
+ */
+
+/**
+ * This is a JavaDoc.
+ *
+ * It has an empty line.
+ */
+
+/** This method does something.
+ *
+ * @param x The first parameter.
+ * @param y The second parameter.
+ * @return The result.
+ */
+
+/**
+ *    This has extra spaces.
+ *
+ * @author   Someone
+ */
+
 class A {
-  {
-    LogEntryEventBuilder logEntryEventBuilder =
-      new LogEntryEventBuilder(
-        getUserSettings(),
-        loggingLevel,
-        shouldSave
-      ).// Don't include the logging system's classes in the stack trace
-      parseStackTrace(
-        new System.DmlException()
-          .getStackTraceString()
-          .replaceAll(
-            '(' + String.join(CLASSES_TO_IGNORE, '|') + ')\\..+?column 1',
-            ''
-          )
-          .trim()
-      );
-  }
 }

tests/comments/CommentsBeforeInterfaceDeclaration.cls

@@ -1,6 +1,6 @@
 // First Test Comment
 
-/**
+/*
 * First ApexDoc
 */
 interface CommentsBeforeInterfaceDeclaration {

tests/comments/CommentsBeforeInterfaceDeclaration.in

@@ -1,6 +1,6 @@
 // First Test Comment
 
-/**
+/*
 * First ApexDoc
 */
 interface CommentsBeforeInterfaceDeclaration {

tests/comments/CommentsBeforeTriggerDeclaration.cls

@@ -1,8 +1,8 @@
 // First Test Comment
 
 /**
-* First ApexDoc
-*/
+ * First ApexDoc
+ */
 trigger Case_trg on Case(before update) {
   System.debug('SOMETHING');
 }

tests/comments/dangling_comments1.cls

@@ -1,6 +1,6 @@
 class A {
   {
-    /**
+    /*
     block comment
     */
 

tests/comments/dangling_comments1.in

@@ -1,7 +1,7 @@
 Class A{
 {
 
-          /**
+          /*
               block comment
 */
 

tests/comments/post_comments1.cls

@@ -5,6 +5,6 @@ class A {
 
 // line comment
 
-/**
+/*
 block comment
 */

tests/comments/post_comments1.in

@@ -5,7 +5,7 @@ Class A{
 
 // line comment
 
-/**
+/*
 block comment
 */
 

tests/comments/post_comments2.cls

@@ -4,7 +4,7 @@ class A {
 
   // line comment
 
-  /**
+  /*
   block comment
   */
 }