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

RESOLVED FIXED

Status

Add-on SDK
General
RESOLVED FIXED
8 years ago
8 years ago

People

(Reporter: warner, Assigned: warner)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Assignee)

Description

8 years ago
Created attachment 438866 [details] [diff] [review]
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.
(Assignee)

Updated

8 years ago
Assignee: nobody → warner-bugzilla
(Assignee)

Updated

8 years ago
Attachment #438866 - Attachment is patch: true
Attachment #438866 - Attachment mime type: application/octet-stream → text/plain
Attachment #438866 - Flags: review?(avarma)

Comment 1

8 years ago
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
Status: NEW → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED

Updated

8 years ago
Attachment #438866 - Flags: review?(avarma) → review+
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".
Component: Jetpack SDK → General
Product: Mozilla Labs → Add-on SDK
QA Contact: jetpack-sdk → general
You need to log in before you can comment on or make changes to this bug.