You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
jsdocs:
The text was updated successfully, but these errors were encountered:
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.
autodoc:
jsdocs:
The text was updated successfully, but these errors were encountered: