DevTools: [JsDocValidator] Check validity of @param and @return annotations

DevTools: [JsDocValidator] Check validity of @param and @return annotations

R=vsevik,sergeyv
NOTRY=true

Committed: https://src.chromium.org/viewvc/blink?view=rev&revision=175579

[aandrey, 2014-06-05 15:03:15]

lgtm

https://codereview.chromium.org/315213003/diff/1/Source/devtools/scripts/jsdo...
File
Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java
(right):

https://codereview.chromium.org/315213003/diff/1/Source/devtools/scripts/jsdo...
Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:20:
Pattern.compile("@param\\s+(\\{.+\\}\\s+)?([^\\s]+).*$", Pattern.MULTILINE);
\\s+  ->  \\s
(let's be more strict and allow exactly 1 space?)

https://codereview.chromium.org/315213003/diff/1/Source/devtools/scripts/jsdo...
Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:23:
Pattern.compile("@return(?:s.*|\\s+[^{]*)$", Pattern.MULTILINE);
"@return(?:s|\\s[^{]|\\s*$)"

this will also handle following cases:

"@return"
"@return value {number}"

[apavlov, 2014-06-05 15:31:50]

https://codereview.chromium.org/315213003/diff/1/Source/devtools/scripts/jsdo...
File
Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java
(right):

https://codereview.chromium.org/315213003/diff/1/Source/devtools/scripts/jsdo...
Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:20:
Pattern.compile("@param\\s+(\\{.+\\}\\s+)?([^\\s]+).*$", Pattern.MULTILINE);
On 2014/06/05 15:03:16, aandrey wrote:
> \\s+  ->  \\s
> (let's be more strict and allow exactly 1 space?)

Technically, this is a valid annotation understood by Closure. My goal is to
detect annotations that look valid to the author but not to the compiler.

https://codereview.chromium.org/315213003/diff/1/Source/devtools/scripts/jsdo...
Source/devtools/scripts/jsdoc-validator/src/org/chromium/devtools/jsdoc/checks/MethodAnnotationChecker.java:23:
Pattern.compile("@return(?:s.*|\\s+[^{]*)$", Pattern.MULTILINE);
On 2014/06/05 15:03:16, aandrey wrote:
> "@return(?:s|\\s[^{]|\\s*$)"
> 
> this will also handle following cases:
> 
> "@return"
> "@return value {number}"

Right, this is INVALID_RETURN_PATTERN :)

[apavlov, 2014-06-05 15:32:13]

The CQ bit was checked by apavlov@chromium.org

[commit-bot: I haz the power, 2014-06-05 15:33:14]

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

[commit-bot: I haz the power, 2014-06-05 15:33:37]

Change committed as 175579