61a3599154
This commit adds support for specifying an Array of tags which are unknown to JSDoc, but allowed without error. It provides a more granular way to disable such errors while retaining the benefits of catching errant tags (e.g. typos). The intended use case is catching errant tags when using additional tools which support tags not recognized by JSDoc (e.g. Closure Compiler and the tags discussed in #605). Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Testing JSDoc 3
Running Tests
Running tests is easy. Just change your working directory to the jsdoc folder and run the following command on Windows:
jsdoc -T
Or on OS X, Linux, and other POSIX-compliant platforms:
./jsdoc -T
Writing Tests
Adding tests is pretty easy, too. You can write tests for JSDoc itself (to make sure tags and the parser, etc. are working properly), tests for plugins, and/or tests for templates.
JSDoc 3 uses Jasmine (https://github.com/pivotal/jasmine) as its testing framework. Take a look at that project's wiki for documentation on writing tests in general.
Tests for JSDoc
Take a look at the files in the test directory for many examples of
writing tests for JSDoc itself. The test\fixtures directory hold fixtures
for use in the tests, and the test\specs directory holds the tests themselves.
Tests for plugins
Tests for plugins are found in the plugins\test directory. Plugins containing
tests that were installed with the Jakefile install task will be run automatically.
Tests for templates
TODO