Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Putting @example in a static object literal declaration doesn't appear in output #384

Open
dmvaldman opened this issue Oct 18, 2015 · 1 comment

Comments

@dmvaldman
Copy link

Example code doesn't appear in parsed output. You may think "why would anyone need an example for an object literal?" but if the object has functions as values, you may want an example to give a high-level overview of the object. Related to #323

    /**
     * My description
     *
     * @example
     *      example code...
     *
     * @class MyObjectLiteral
     * @static
     */
     var MyObjectLiteral = {};
@okuryu
Copy link
Member

okuryu commented Nov 9, 2015

Yeah, @example tag currently doesn't works with @class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants