authorgravatar for kappaloris@gmail.comLoris Cro <kappaloris@gmail.com> 2022-08-02 16:32:08+02:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2022-08-02 16:32:08+02:00
log2375658da9f8e73d3e4b6d14d88c02cc765ae579
tree79fd1b86db9ea4ba66f6cc19ffa6c73d268702c0
parent9ba2377d6406ef57695f3297b91f35f3ad1705b5
parent2c7387aef5c24a463ef9fc15809df570b6463bba
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #12276 from r00ster91/shortdesc

autodoc: better short description algorithm

1 files changed, 14 insertions(+), 5 deletions(-)

lib/docs/main.js+14-5
...@@ -2643,14 +2643,23 @@ var zigAnalysis;...@@ -2643,14 +2643,23 @@ var zigAnalysis;
2643 });2643 });
2644 }2644 }
26452645
2646 2646
2647 function shortDescMarkdown(docs) {2647 function shortDescMarkdown(docs) {
2648 let parts = docs.trim().split("\n");2648 const trimmed_docs = docs.trim();
2649 let firstLine = parts[0];2649 let index = trimmed_docs.indexOf('.');
2650 return markdown(firstLine);2650 if (index < 0) {
2651 index = trimmed_docs.indexOf('\n');
2652 if (index < 0) {
2653 index = trimmed_docs.length;
2654 }
2655 } else {
2656 index += 1; // include the period
2657 }
2658 const slice = trimmed_docs.slice(0, index);
2659 return markdown(slice);
2651 }2660 }
26522661
2653 2662
2654 function markdown(input) {2663 function markdown(input) {
2655 const raw_lines = input.split('\n'); // zig allows no '\r', so we don't need to split on CR2664 const raw_lines = input.split('\n'); // zig allows no '\r', so we don't need to split on CR
2656 2665