dtao / autodoc

Doc generation on steroids
https://npmjs.org/package/autodoc
MIT License
232 stars 15 forks source link

Properly support @param object properties #55

Open b225ccc-zz opened 9 years ago

b225ccc-zz commented 9 years ago

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