Skip to content

Commit 1c5d2c6

Browse files
committed
refactor: update parseDocComment
1 parent 6e31e6e commit 1c5d2c6

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

src/parse-doc-comment.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@ import memoize from "memoize";
44
/**
55
`parseDocComment` parses a JSDoc comment using `@microsoft/tsdoc`.
66
7+
@remarks
78
Parsed comments are memoized.
89
9-
@param s - the raw string comment
10-
11-
@internal
10+
@param comment - the raw string comment
1211
*/
13-
export const parseDocComment = memoize((s: string): DocComment => {
12+
export const parseDocComment = memoize((comment: string): DocComment => {
1413
const parser = new TSDocParser();
15-
return parser.parseString(s).docComment;
14+
return parser.parseString(comment).docComment;
1615
});

0 commit comments

Comments
 (0)