Docs code should enable writers to document complex return types

RESOLVED FIXED

Status

Add-on SDK
Documentation
P2
normal
RESOLVED FIXED
5 years ago
4 years ago

People

(Reporter: wbamberg, Assigned: wbamberg)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

(Assignee)

Description

5 years ago
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.

Updated

4 years ago
Priority: -- → P2
(Assignee)

Comment 1

4 years ago
Fixed by migrating the SDK docs to MDN...
Status: NEW → RESOLVED
Last Resolved: 4 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.