mirrors/zig
1
0
Fork 0
mirror of https://codeberg.org/ziglang/zig.git synced 2025-12-06 13:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

autodoc: better short description algorithm

Browse source
This commit is contained in:
r00ster91 2022-07-28 20:49:55 +02:00
parent e863292fe2
commit 2c7387aef5
1 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
lib/docs/main.js
View file

@ -2639,14 +2639,23 @@ var zigAnalysis;
}); });
} }
function shortDescMarkdown(docs) { function shortDescMarkdown(docs) {
let parts = docs.trim().split("\n"); const trimmed_docs = docs.trim();
let firstLine = parts[0]; let index = trimmed_docs.indexOf('.');
return markdown(firstLine); 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) { function markdown(input) {
const raw_lines = input.split('\n'); // zig allows no '\r', so we don't need to split on CR const raw_lines = input.split('\n'); // zig allows no '\r', so we don't need to split on CR