Issue 301383002: DevTools: [JsDocValidator] Check that param lists are completely annotated

Issue 301383002: DevTools: [JsDocValidator] Check that param lists are completely annotated (Closed)

Created:
6 years, 6 months ago by apavlov

Modified:
6 years, 6 months ago

Reviewers:
sergeyv

CC:
blink-reviews, caseq+blink_chromium.org, loislo+blink_chromium.org, eustas+blink_chromium.org, malch+blink_chromium.org, yurys+blink_chromium.org, lushnikov+blink_chromium.org, vsevik+blink_chromium.org, pfeldman+blink_chromium.org, paulirish+reviews_chromium.org, apavlov+blink_chromium.org, devtools-reviews_chromium.org, sergeyv+blink_chromium.org, aandrey+blink_chromium.org

Base URL:
svn://svn.chromium.org/blink/trunk

Visibility:
Public.

More Reviews

Description

DevTools: [JsDocValidator] Check that param lists are completely annotated Having the @param annotation for only a part of function's params is both confusing (makes people think the function is properly annotated) and error-prone (missing a @param can result in subtle coding errors). R=sergeyv NOTRY=true Committed: https://src.chromium.org/viewvc/blink?view=rev&revision=175280

Patch Set 1 #

Patch Set 2 : Simplify checks #

Total comments: 4

Patch Set 3 : Address comments #

Created: 6 years, 6 months ago

Download [raw] [tar.bz2]

	Unified diffs	Side-by-side diffs	Delta from patch set	Stats (+167 lines, -384 lines)			Patch
M	Source/devtools/scripts/jsdoc-validator/build_jsdoc_validator_jar.py	View		1 chunk	+2 lines, -1 line	0 comments	Download
M	Source/devtools/scripts/jsdoc-validator/hashes	View	1 2	1 chunk	+2 lines, -2 lines	0 comments	Download
M	Source/devtools/scripts/jsdoc-validator/jsdoc-validator.jar	View	1 2	Binary file		0 comments	Download
M	Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/ContextTrackingValidationCheck.java	View		1 chunk	+1 line, -1 line	0 comments	Download
A +	Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java	View	1 2	4 chunks	+46 lines, -1 line	0 comments	Download
A +	Source/devtools/scripts/jsdoc-validator/tests/function.js	View		1 chunk	+22 lines, -0 lines	0 comments	Download
M	Source/devtools/scripts/jsdoc-validator/tests/golden.dat	View		2 chunks	+94 lines, -86 lines	0 comments	Download
D	Source/devtools/scripts/jsdoc-validator/tests/return.js	View		1 chunk	+0 lines, -293 lines	0 comments	Download

Messages

Total messages: 10 (0 generated)

Expand Messages | Collapse Messages

sergeyv

https://codereview.chromium.org/301383002/diff/20001/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java File Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java (right): https://codereview.chromium.org/301383002/diff/20001/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java#newcode198 Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:198: private static class ParamData { Why do we still ...

6 years, 6 months ago (2014-06-02 09:27:02 UTC) #2

sergeyv

https://codereview.chromium.org/301383002/diff/20001/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java File Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java (right): https://codereview.chromium.org/301383002/diff/20001/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java#newcode51 Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:51: if (result.length() > 0) { Looks like we can ...

6 years, 6 months ago (2014-06-02 09:40:25 UTC) #5

apavlov

https://codereview.chromium.org/301383002/diff/20001/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java File Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java (right): https://codereview.chromium.org/301383002/diff/20001/Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java#newcode51 Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:51: if (result.length() > 0) { On 2014/06/02 09:40:26, sergeyv ...

6 years, 6 months ago (2014-06-02 10:28:03 UTC) #6

commit-bot: I haz the power

CQ is trying da patch. Follow status at https://chromium-status.appspot.com/cq/apavlov@chromium.org/301383002/40001

6 years, 6 months ago (2014-06-02 12:24:21 UTC) #9

Message was sent while issue was closed.

Change committed as 175280

Expand Messages | Collapse Messages