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

How to document an options argument ? #131

Closed
luozhihua opened this issue Oct 12, 2014 · 2 comments
Closed

How to document an options argument ? #131

luozhihua opened this issue Oct 12, 2014 · 2 comments

Comments

@luozhihua
Copy link

For example:

/**
 * Person Class
 * @class Person
 * @param {Object}  details Person details
 */
function Person(details) {
    this.name = details.name;
    this.department = details.department;
    // ...
}

I must to tell the other developers to know, That what properties are details allowed.

@neogeek
Copy link
Contributor

neogeek commented Oct 12, 2014

Per the discussion found in issue #115 you can describe the properties of details like this:

/**
 * Person Class
 * @class Person
 * @param {Object} details Person details.
 * @param {Object} details.name Name of person.
 * @param {Object} details.department Department person works in.
 */

@luozhihua
Copy link
Author

Thank's a lot!

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