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

Properly support @param object properties #55

Open
b225ccc-zz opened this issue Jun 18, 2015 · 0 comments
Open

Properly support @param object properties #55

b225ccc-zz opened this issue Jun 18, 2015 · 0 comments

Comments

@b225ccc-zz
Copy link

Specifying object properties like this (below) does not result in the correct documentation. The object properties should go in a nested table in the row for the object - 'opts', in this case. With autodoc, each object property gets it's own line in the main table. Also, using 'opts.host' as an example, the string ".host - Hostname or IP address" ends up in the Description column.

/**
 * @param {Object} opts - The connection options object
 * @param {string} opts.host - Hostname or IP address
 * @param {integer} opts.port - Port number
 * @param {string=} opts.username - Username
 * @param {string=} opts.password - Password
 */
autodoc --version
0.6.2

autodoc:
image

jsdocs:
image

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

1 participant