tag:blogger.com,1999:blog-8501278254137514883.post468818228023524505..comments2024-02-29T05:27:16.639-08:00Comments on pamela fox's blog: How do you document an options Object?Pamela Foxhttp://www.blogger.com/profile/15947664772001597300noreply@blogger.comBlogger3125tag:blogger.com,1999:blog-8501278254137514883.post-45532230286369407542009-05-05T17:38:00.000-07:002009-05-05T17:38:00.000-07:00Thanks for the feedback, guys.
Roman, I really li...Thanks for the feedback, guys.<br /><br />Roman, I really like that style, thanks for the pointer.Pamela Foxhttps://www.blogger.com/profile/15947664772001597300noreply@blogger.comtag:blogger.com,1999:blog-8501278254137514883.post-6994259277306412142009-05-05T17:33:00.000-07:002009-05-05T17:33:00.000-07:00Here's how I do it:
http://code.google.com/p/geoj...Here's how I do it:<br /><br />http://code.google.com/p/geojs/wiki/GeoMathReference#destination(start,_options)Roman Nurik, Android Developer Relationshttps://www.blogger.com/profile/18437643461371746729noreply@blogger.comtag:blogger.com,1999:blog-8501278254137514883.post-6048548474613216452009-05-05T16:01:00.000-07:002009-05-05T16:01:00.000-07:00I don't like documentation that pushes the options...I don't like documentation that pushes the options key:value descriptions into a new section of the docco. Perhaps this sort of behaviour extends from giving them "class names" like GMarkerOptions.<br /><br />As you started with, think of the API: we're using an Object just to make our API more effective, so the documentation should describe this relationship inline with the rest of the method's definitionAnonymousnoreply@blogger.com