Closed Bug 1397785 Opened 7 years ago Closed 7 years ago

Document what the members of ChannelWrapper mean

Categories

(WebExtensions :: Request Handling, enhancement, P5)

Product:
WebExtensions
Component:
Request Handling
Type:
enhancement

Tracking

(firefox57 wontfix)

Status:
RESOLVED FIXED
Tracking Flags:
Tracking Status
firefox57 --- wontfix

People

(Reporter: bzbarsky, Unassigned)

References

Details

ChannelWrapper.webidl has members like "originURL" and "documentURL" which do not have any documentation and whose meaning is not particularly clear to me. They don't seem to map to anything obvious on nsIChannel, either, unlike things like "loadInfo"... Ideally, all the members of this interface would be documented in terms of what they are supposed to mean, for two reasons: 1) This will allow checking whether consumers are using the right API without having to read the implementation. 2) This will allow checking whether the implementation matches the intended meaning.
status-firefox57: affected → wontfix
Priority: -- → P5
I did this in part 1 of bug 1402944.
Depends on: 1402944
Looks like this is done.
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Product: Toolkit → WebExtensions
You need to log in before you can comment on or make changes to this bug.