Closed Bug 892608 Opened 11 years ago Closed 10 years ago

Docs code should enable writers to document complex return types

Categories

(Add-on SDK Graveyard :: Documentation, defect, P2)

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: wbamberg, Assigned: wbamberg)

Details

At the moment the SDK documentation-generation-code can only represent return values with the name of the type, like "Returns: string". This isn't helpful in cases where the code returns a complex custom object that itself needs documenting. It would be good in these cases to enable the writer to document this custom object.

This would be helpful in the Places API, where "save" and "search" functions return event emitters whose events need to be documented somewhere, and there's no obvious place to do this in the current system.
Fixed by migrating the SDK docs to MDN...
Status: NEW → RESOLVED
Closed: 10 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.