Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

omit description if not found after the first heading #115

Merged
merged 1 commit into from
Sep 4, 2024
Merged

omit description if not found after the first heading #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion scripts/generateApidocs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@ function getMdDesc(fileContent) {
// reads text after the first heading in md file and stops at either line change or EOF
const match = fileContent.match(/#\s+(.*)\r?\n\r?\n([^]*?)(?=\r?\n\r?\n|$)/);
if (match && match.length > 1) {
return match[2];
// if the content that follows after the first heading if another heading, just return empty (=there is no paragraph marking the short description)
if (!match[2].startsWith('#')) {
return match[2];
}
}

return '';
Expand Down
Loading