559204 - API docs renderer: tolerate missing param.type or missing params

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Brian Warner [:warner :bwarner]]

Attachment: patch to fix the renderer

Here's a small patch to let the API renderer to tolerate docs which leave out the type on a @param tag, or which have no @param tags at all. Both are tolerated by the parser, and thus need to be handled by the renderer. The current behavior is a JS exception, and can be seen by copying the APIdoc sample file (python-lib/cuddlefish/tests/static-files/docs/APIsample.md) into (packages/jetpack-core/docs/) and then using "cfx docs" to view that file.

Comment 1

[Atul Varma [:atul]]

Looks good, thanks!

Pushed:

Bug 559204 - API docs renderer: tolerate missing param.type or missing params
Brian Warner [:warner]
http://hg.mozilla.org/labs/jetpack-sdk/rev/fb747310a07b2e3d39bdeb5a57584974b46e523c

Comment 2

[Myk Melez [:myk] [@mykmelez]]

The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".