google / closure-linter

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

Unexpected "Invalid JsDoc tag: module" #66

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
What steps will reproduce the problem?

Lint this file:
/**
 * @module Application
 */
define(
    function() {
        'use strict';

        /**
         * @constructor
         */
        function Application() {
        }

        return Application;
    }
);

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

@module is a regular JSDoc annotation since JSDoc 3:
http://usejsdoc.org/howto-commonjs-modules.html
=> This tag should be accepted.

This error occurs:
Line 2, E:0200: Invalid JsDoc tag: module

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

2.3.10, Mac OSX Mountain Lion

Original issue reported on code.google.com by visusnor...@gmail.com on 10 May 2013 at 8:48

GoogleCodeExporter commented 9 years ago
[deleted comment]
GoogleCodeExporter commented 9 years ago
@module is missing here, too:
https://developers.google.com/closure/compiler/docs/js-for-compiler

I guess there are more missing annotations (@class, @exports, @alias, a.s.o. 
See the section "JSDoc 3 Tag Dictionary" here: http://usejsdoc.org/)

Original comment by visusnor...@gmail.com on 10 May 2013 at 8:58

GoogleCodeExporter commented 9 years ago
The Closure Linter supports the tags of the Google JavaScript Style Guide, not 
the tags of jsdoc, which while they overlap are not the same.

You can indicate the linter should not error on a given tag by specifying it on 
the command line via the --custom_jsdoc_tags flag, however, you will not get an 
syntax checking for that flag.

Original comment by a...@google.com on 4 Dec 2013 at 11:21