Closed Bug 570809 Opened 15 years ago Closed 15 years ago

docs parser - options @prop do not have correct style

Categories

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

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: fiveinchpixie, Assigned: adw)

Details

Attachments

(1 file)

Attempting to define @props of a options bag; it shows all of the props as required on the website regardless of how they are defined in the markdown: <abbreviated api def> @param options {array} @prop label {string} This is the item's label. @prop [data] {string} This is the item's label. </abbreviated api def> Both properties are "normal"; not "normal" for required and italic for [optional]
Attached patch patchSplinter Review
Easy fix, the JSON includes a "required" property for @props, it's just not reflected in the HTML.
Assignee: nobody → adw
Status: NEW → ASSIGNED
Attachment #449991 - Flags: review?(warner-bugzilla)
Comment on attachment 449991 [details] [diff] [review] patch looks good to me.. thanks!
Attachment #449991 - Flags: review?(warner-bugzilla) → review+
Status: ASSIGNED → RESOLVED
Closed: 15 years ago
Resolution: --- → FIXED
OS: Mac OS X → All
Hardware: x86 → All
Target Milestone: -- → 0.5
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.

Attachment

General

Created:
Updated:
Size: