Skip to content

Commit af469fd

Browse files
authored
Merge pull request github#1773 from xiemaisi/js/undocumented-parameter-precision
Approved by esben-semmle
2 parents 1c51c34 + d105de8 commit af469fd

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

change-notes/1.22/analysis-javascript.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
| Shift out of range | Fewer false positive results | This rule now correctly handles BigInt shift operands. |
3232
| Conflicting HTML element attributes | Fewer results | Results are no longer shown on LGTM by default. |
3333
| Superfluous trailing arguments | Fewer false-positive results. | This rule no longer flags calls to placeholder functions that trivially throw an exception. |
34+
| Undocumented parameter | No changes to results | This rule is now run on LGTM, although its results are still not shown by default. |
3435

3536
## Changes to QL libraries
3637

javascript/ql/src/JSDoc/UndocumentedParameter.ql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* @tags maintainability
99
* readability
1010
* documentation
11-
* @precision medium
11+
* @precision high
1212
*/
1313

1414
import javascript
@@ -22,6 +22,6 @@ where
2222
exists(doc.getATag().(JSDocParamTag).getDocumentedParameter()) and
2323
// but v is not
2424
not doc.getATag().(JSDocParamTag).getDocumentedParameter() = v and
25-
// don't report a violation in ambiguous cases
25+
// don't report an alert in ambiguous cases
2626
strictcount(JSDoc d | d = f.getDocumentation() and d.getATag() instanceof JSDocParamTag) = 1
2727
select parm, "Parameter " + v.getName() + " is not documented."

0 commit comments

Comments
 (0)