Awesome API Documentation

[dignifiedquire]

Ref ipfs/js-ipfs#615

[coveralls]

Coverage remained the same at 99.614% when pulling 2d3352a on VictorBjelkholm:api-docs into d0faf10 on multiformats:master.

[victorb]

@dignifiedquire should be ok now, please leave feedback :)

Preview: https://victorbjelkholm.github.io/js-multiaddr/

[coveralls]

Coverage remained the same at 99.614% when pulling 38f7c32 on VictorBjelkholm:api-docs into d0faf10 on multiformats:master.

[dignifiedquire]

Cool stuff @victorbjelkholm, not super happy about this though:

which is not your fault, but this needs some work in the theme/parsing

[dignifiedquire]

So it turns out the general notion of how to document this in jsdoc are one of the two following

Complex

Allows for individual property descriptions, but adds another section

/**
 * @typedef {Object} Protocols
 * @param {Array}  table
 * @param {Object} names
 * @param  {Object} codes - protocols
 */
/**
 * @returns {Protocols}
 */

Simple

Does not allow for description of individual properties

/**
 * @returns {{table: Array, names: Object, codes: Object}}
 */

[victorb]

@diasdavid

diasdavid requested a review from VictorBjelkholm 5 hours ago

PR is from me, might be better for @dignifiedquire or you to review it :)

[dignifiedquire]

@victorbjelkholm could you update the return values to use one of the two variants I listed above please?

[victorb]

@dignifiedquire thanks, applied where applicable

[coveralls]

Coverage remained the same at 99.614% when pulling f333899 on VictorBjelkholm:api-docs into d0faf10 on multiformats:master.

[coveralls]

Coverage remained the same at 99.614% when pulling f333899 on VictorBjelkholm:api-docs into d0faf10 on multiformats:master.

[dignifiedquire]

@victorbjelkholm you missed this one :)

[coveralls]

Coverage remained the same at 99.614% when pulling bd27709 on VictorBjelkholm:api-docs into d0faf10 on multiformats:master.

[coveralls]

Coverage remained the same at 99.614% when pulling bd27709 on VictorBjelkholm:api-docs into d0faf10 on multiformats:master.

[dignifiedquire]

LGTM