280358 - [FIX]Better document nsIHttpChannel

Status: RESOLVED FIXED

(Core :: Networking: HTTP, defect)

Description

[Boris Zbarsky [:bzbarsky]]

Some methods on nsIHttpChannel don't document behavior in common cases...

Comment 1

[Boris Zbarsky [:bzbarsky]]

Attachment: Something like this

Comment 2

[Darin Fisher]

Comment on attachment 172816 [details] [diff] [review]
Something like this

>Index: netwerk/protocol/http/public/nsIHttpChannel.idl

>+     * This attribute may only be set before the channel is opened.
>+     *
>+     * @throws NS_ERROR_IN_FAILURE if set after the channel has been opened.
>      */
>     attribute boolean allowPipelining;

s/FAILURE/PROGRESS/


r+sr=darin

Comment 3

[Christian :Biesinger (don't email me, ping me on IRC)]

+     * @throws NS_ERROR_NOT_AVAILABLE if the header has no value (is not set).
      */
     ACString getRequestHeader(in ACString aHeader);

"if the header is not set"?  to make it clear that it won't be thrown for ""...

Comment 4

[Boris Zbarsky [:bzbarsky]]

> s/FAILURE/PROGRESS/

Actually, s/IN_//.  The function returns NS_ERROR_FAILURE if mPending is set.


  

Comment 5

[Boris Zbarsky [:bzbarsky]]

checked in, with the issues fixed.