search

readyou / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

support: best way to document input objects #342

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
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,

Original issue reported on code.google.com by descarta...@gmail.com on 23 Oct 2012 at 5:02

GoogleCodeExporter commented 9 years ago 
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

Original comment by descarta...@gmail.com on 23 Oct 2012 at 10:40