zig

commit 2375658da9f8e73d3e4b6d14d88c02cc765ae579 (tree)
parent 9ba2377d6406ef57695f3297b91f35f3ad1705b5
Author: Loris Cro <kappaloris@gmail.com>
Date:   Tue,  2 Aug 2022 16:32:08 +0200

Merge pull request #12276 from r00ster91/shortdesc

autodoc: better short description algorithm
Diffstat:
M
lib/docs/main.js
 | 
19
++++++++++++++-----

1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/lib/docs/main.js b/lib/docs/main.js
@@ -2643,14 +2643,23 @@ var zigAnalysis;
         });
     }
 
-    
+
     function shortDescMarkdown(docs) {
-        let parts = docs.trim().split("\n");
-        let firstLine = parts[0];
-        return markdown(firstLine);
+        const trimmed_docs = docs.trim();
+        let index = trimmed_docs.indexOf('.');
+        if (index < 0) {
+            index = trimmed_docs.indexOf('\n');
+            if (index < 0) {
+                index = trimmed_docs.length;
+            }
+        } else {
+            index += 1; // include the period
+        }
+        const slice = trimmed_docs.slice(0, index);
+        return markdown(slice);
     }
 
-    
+
     function markdown(input) {
         const raw_lines = input.split('\n'); // zig allows no '\r', so we don't need to split on CR