Skip to content

Commit f26da6f

Browse files
author
nickpape-msft
authored
Merge pull request microsoft#55 from Microsoft/dagaeta/api-extractor-comment-fixes
Adding change file for 'changing JsDoc sequence checking and error reporting'
2 parents eea65c2 + 7dcf0a1 commit f26da6f

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

‎api-extractor/src/TypeScriptHelpers.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ export default class TypeScriptHelpers {
6969
const jsDocFullText: string = nodeJsDocObjects[lastJsDocIndex].getText();
7070
const jsDocLines: string[] = jsDocFullText.split(TypeScriptHelpers.newLineRegEx);
7171
const jsDocStartSeqExists: boolean = TypeScriptHelpers.jsDocStartRegEx.test(jsDocLines[0].toString());
72+
73+
// Report error for each missing sequence seperately
7274
if (!jsDocStartSeqExists) {
7375
errorLogger('JsDoc comment must begin with a \"/**\" sequence.');
7476
return '';

‎common/changes/dagaeta-api-extractor-comment-fixes_2017-01-19-19-27.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@microsoft/api-extractor",
5+
"comment": "Check for missing JsDoc sequences changed.",
6+
"type": "patch"
7+
}
8+
],
9+
"email": "dgaeta@users.noreply.github.com"
10+
}

0 commit comments

Comments
 (0)