feat: allow multiple details lines

Author: SuperFola

arkdoc/generator/base.py

@@ -80,7 +80,8 @@ def generate_sections(self, functions: List[spec.Function], with_hr: bool = Fals
                     self.formatter.h4(self.formatter.plural("Parameter", len(func.desc.params))),
                     self.formatter.ul(
                         [
-                            f"{self.formatter.inline_code(p.name)}: {p.desc}" if p.desc else self.formatter.inline_code(p.name)
+                            f"{self.formatter.inline_code(p.name)}: {p.desc}" if p.desc else self.formatter.inline_code(
+                                p.name)
                             for p in func.desc.params
                         ]
                     ),
@@ -120,7 +121,9 @@ def generate_sections(self, functions: List[spec.Function], with_hr: bool = Fals
                 self.formatter.new_line(),
                 maybe_deprecated_notice,
                 maybe_changelists,
-                self.formatter.div(self.formatter.b("Note"), ": ", func.desc.details) if func.desc.details else "",
+                self.formatter.div(
+                    self.formatter.b("Note"), ": ",
+                    self.formatter.new_line().join(func.desc.details)) if func.desc.details else "",
                 self.formatter.new_line(),
                 authors,
                 self.formatter.new_line(),

arkdoc/generator/utils.py

@@ -10,7 +10,7 @@
 
 DEFAULT_KEYS = {
     "brief": "",
-    "details": "",
+    "details": [],
     "param": [],
     "author": "",
     "deprecated": "",
@@ -20,10 +20,22 @@
 
 def extractor(data: Dict, doc: Documentation) -> Tuple[Dict, str]:
     in_code = False
+    in_details = False
     code = []
+    details = []
 
     for comment in doc.comments:
-        if not in_code:
+        if in_code:
+            if "=end" not in comment.value:
+                code.append(comment.value)
+            else:
+                in_code = False
+        elif in_details:
+            if "=details-end" not in comment.value:
+                details.append(comment.value)
+            else:
+                in_details = False
+        else:
             for key in data:
                 tag = f"@{key}"
 
@@ -38,15 +50,15 @@ def extractor(data: Dict, doc: Documentation) -> Tuple[Dict, str]:
             else:
                 if "=begin" in comment.value:
                     in_code = True
-        else:
-            if "=end" not in comment.value:
-                code.append(comment.value)
-            else:
-                in_code = False
+                if "=details-begin" in comment.value:
+                    in_details = True
 
     if code:
         margin = code[0].index("(")
         code = [line[margin:] for line in code]
+    if details:
+        details = [line.removeprefix("#").strip() for line in details]
+        data["details"] += details
 
     if "param" in data:
         for i, param in enumerate(data["param"]):

arkdoc/parser/tokenizer.py

@@ -70,7 +70,7 @@ def cpp_tokenize(code: str) -> Generator[list[Token], Any, None]:
       * @brief test
     */
     """
-    tok_regex = r"^ */\*\*\n( *\*( .*)\n)+"
+    tok_regex = r"^ */\*\*\n( *\*( *.*)\n)+"
     line_num = 1
     line_start = 0