From 2c7387aef5c24a463ef9fc15809df570b6463bba Mon Sep 17 00:00:00 2001 From: r00ster91 Date: Thu, 28 Jul 2022 20:49:55 +0200 Subject: [PATCH] autodoc: better short description algorithm --- lib/docs/main.js | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/lib/docs/main.js b/lib/docs/main.js index 8be263e57f..da1d90fb3e 100644 --- a/lib/docs/main.js +++ b/lib/docs/main.js @@ -2639,14 +2639,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