Closed Bug 576420 Opened 14 years ago Closed 14 years ago

Fix documentation bug about nsIInputStream::Available and EOF

Categories

(Core :: XPCOM, defect)

x86
Linux
defect
Not set
normal

Tracking

()

RESOLVED FIXED

People

(Reporter: jduell.mcbugs, Assigned: jduell.mcbugs)

Details

Attachments

(1 file, 1 obsolete file)

Attached patch Fix IDL comment (obsolete) — Splinter Review
At one place in IDL it says Available() will return 0 bytes if at EOF, but then the @throws comment says it will throw if EOF.   0 bytes appears to be correct.
Attachment #455587 - Flags: review?(bzbarsky)
Comment on attachment 455587 [details] [diff] [review]
Fix IDL comment

I think what this meant to say is that you get NS_BASE_STREAM_CLOSED if the stream is closed normally and that some streams do this automatically at EOF (see nsIFileStreams).

Do you think just saying "closed normally" here (and perhaps documenting that the closure will be normal closure over in nsIFileStreams) expresses that?
bz: OK, how about this?
Attachment #455587 - Attachment is obsolete: true
Attachment #456527 - Flags: review?(bzbarsky)
Attachment #455587 - Flags: review?(bzbarsky)
Attachment #456527 - Flags: review?(bzbarsky) → review+
http://hg.mozilla.org/mozilla-central/rev/ad5644e101fd
Status: NEW → RESOLVED
Closed: 14 years ago
Resolution: --- → FIXED
Assignee: nobody → jduell.mcbugs
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: