suppose f() receives one argument that is a complex object, with properties that may be required, optional, with nested objects, defaults that must be documented, etc. technically, it only have one parameter.

what's the best pattern to document those cases?

for now i'm simply adding html to the docstring of the method. but it's ugly and not every template plays nice with it.

what's the proper way to document that?

thank you,

found this discussion[1], but not sure what's the way the jsdoc documentation should advocate at this point as the norm.

[1] https://groups.google.com/forum/?fromgroups=#!topic/jsdoc-users/izErstbwNUU