google / closure-linter

Automatically exported from code.google.com/p/closure-linter
Apache License 2.0
111 stars 37 forks source link

Doesn't allows Object parameter description, using multiple params #84

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
What steps will reproduce the problem?
1. Create function with valid jsdoc, containing object description with 
multiple params, like this: 
https://gist.github.com/anonymous/e57415453d755e5e6e9f
2. Run closure linter.
3. Receive error about jsdoc description for missing parameter.

What is the expected output? What do you see instead?

Expected to see no error. Receive error.

What version of the product are you using? On what operating system?

Latest version. Linux/MacOS.

Original issue reported on code.google.com by ymi...@gmail.com on 28 Aug 2014 at 2:33

GoogleCodeExporter commented 9 years ago
This issue is fixed here

https://github.com/39dotyt/closure-linter-now

Original comment by ymi...@gmail.com on 29 Aug 2014 at 1:28

GoogleCodeExporter commented 9 years ago
Your function only takes one param: "module". So there should only be one 
@param tag. The @param tag can refer to an @constructor or @typedef type though 
to specify the expected interface more granularly.

Original comment by rum...@google.com on 15 Jan 2015 at 8:50

GoogleCodeExporter commented 9 years ago
But, JSDoc reference documentation says, that this way is completely correct.

Original comment by ymi...@gmail.com on 15 Jan 2015 at 4:33