js: how to document object param in function?

For example simple function:
/**
* Test function
* @param {object} options
*/
function a(options){};

Is there a way to document available params of options object?

2 comments
Comment actions Permalink

Hi, Mikhail.
If I correctly understand you, record types syntax in google closure compiler is what you want, but WebStorm 4 does not support it. It will be included in 5th version and nearest EAP. Anyway, you could use mentioned syntax now, but incorrect warnings will be produced. See issue IDEA-86054 and related.

0
Comment actions Permalink

Yes, you understand correctly. Record type syntax probably satisfy my expectations. I will try that in 5th version.

0

Please sign in to leave a comment.