hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-30 11:15:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

JavaScript: Raise precision of UndocumentedParameter to high.

Browse Source 
This is more consistent with the other JSDoc queries. Results are still not shown on LGTM by default, but the query can now be enabled selectively for projects that care about JSDoc.
This commit is contained in:
Max Schaefer
2019-08-20 09:30:52 +01:00
parent 432b0a4698
commit d105de81a3
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
javascript/ql/src/JSDoc/UndocumentedParameter.ql
View File

@@ -8,7 +8,7 @@
* @tags maintainability
* readability
* documentation
* @precision medium
* @precision high
*/
import javascript
@@ -22,6 +22,6 @@ where
exists(doc.getATag().(JSDocParamTag).getDocumentedParameter()) and
// but v is not
not doc.getATag().(JSDocParamTag).getDocumentedParameter() = v and
// don't report a violation in ambiguous cases
// don't report an alert in ambiguous cases
strictcount(JSDoc d | d = f.getDocumentation() and d.getATag() instanceof JSDocParamTag) = 1
select parm, "Parameter " + v.getName() + " is not documented."