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

@memberof @lends not generated #1222

Closed
pixelass opened this issue Jun 9, 2016 · 2 comments
Closed

@memberof @lends not generated #1222

pixelass opened this issue Jun 9, 2016 · 2 comments

Comments

@pixelass
Copy link

pixelass commented Jun 9, 2016

setting @lends and @memberof tags results in methods not being generated at all.

This example code from usejsdoc will not exist in the documentation.

var Person = makeClass(
    /** @lends Person.prototype */
    {
        /** @constructs */
        initialize: function(name) {
            this.name = name;
        },
        say: function(message) {
            return this.name + " says: " + message;
        }
    }
);

This pretty much makes both tags either useless, buggy or the documentation is delivers false information.

@pixelass
Copy link
Author

pixelass commented Jun 9, 2016

might be related to: #1130

@hegemonic
Copy link
Contributor

You need to document the say method to get it to show up in the docs. This works for me:

var Person = makeClass(
    /** @lends Person.prototype */
    {
        /** @constructs */
        initialize: function(name) {
            this.name = name;
        },
        /**
         * Say something.
         * @param {string} message - The message to say.
         * @return {string} What the person says.
         */
        say: function(message) {
            return this.name + " says: " + message;
        }
    }
);

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

No branches or pull requests

2 participants