Skip to content
This repository was archived by the owner on Mar 18, 2024. It is now read-only.

Expand C-family docstring resolution #567

Merged
merged 2 commits into from
Feb 3, 2021
Merged

Expand C-family docstring resolution #567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08dc4e0
Ignore empty lines between docstring and definition.
efritz Feb 3, 2021
dad0d8a
Add docstring ignore to c-family comment styles.
efritz Feb 3, 2021
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
12 changes: 11 additions & 1 deletion shared/language-specs/cpp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,17 @@ export const cppSpec: LanguageSpec = {
'pc', // Pro-C by Oracle RDBMS
'pcc', // Pro-C by Oracle RDBMS
],
commentStyles: [cStyleComment],
commentStyles: [
{
...cStyleComment,
// Ignore identifiers between definition line and doc block. This enables
// correctly finding doc strings for function definitions that span multiple
// lines (return type and function name separated by a newline). We'll only
// enable this for C-family languages as it seems to be the most pervasive
// language with this style.
...{ docstringIgnore: /^[\s\w]+/ },
},
],
filterDefinitions,
lsifSupport: LSIFSupport.Experimental,
}
Expand Down
2 changes: 1 addition & 1 deletion shared/search/docstrings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ function findDocstringInBlockComment({
docstringIgnore?: RegExp
}): string[] | undefined {
// Drop any leading ignored content between the definition and the docstring
const cleanLines = dropWhile(lines, line => docstringIgnore?.test(line))
const cleanLines = dropWhile(lines, line => docstringIgnore?.test(line) || line.trim() === '')

// Check for starting delimiter
if (!cleanLines[0] || !startRegex.test(cleanLines[0])) {
Expand Down