Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The JsDoc plugin makes better JsDoc Annotations from Closure Annotations.
JavaScript
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
README.textile
closureLib.js

README.textile

Closure annotation for JsDoc

Abstract

This is a JsDoc-toolkit plugin that makes better JsDoc annotations from Closure annotations.
The plugin do not work on JsDoc3, so use closure-annotate-jsdoc3 .

For example:
your script:

goog.provide('foo');


/** @const */
foo.CONST = 'foobar'; // This constant will NOT be listed.

The constant will not be listed.
So, this plugin add namespace annotation then it finds using goog.provide in your script:

/**
 * @namespace
 * @name foo
 */


/** @const */
foo.CONST = 'foobar'; // This constant will be listed.

And the plugin will not add namespace annotation if the argument looks like a constructor name.

Install

The interface was designed to be simple. If you are using a plugin, installing it is as easy as saving the plugin file to the app/plugins directory – that’s it. The plugin will automatically be loaded and used for you.

See the official documents , if you want more information.

Changelog

  • Respond to “goog.addSingletonGetter” – Feb. 25, 2012
Something went wrong with that request. Please try again.