Closed Bug 396069 Opened 17 years ago Closed 17 years ago

[FIX]Better docs for nsIPipe.init

Categories

(Core :: XPCOM, defect)

Product:
Core
Component:
XPCOM
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

()

Status:
RESOLVED FIXED
Milestone:
mozilla1.9beta1

People

(Reporter: bzbarsky, Assigned: bzbarsky)

Details

Attachments

(1 file)

Comments
1.94 KB, patch
benjamin
: review+
Biesinger
: superreview+
benjamin
: approval1.9+
Details | Diff | Splinter Review
Attached patch Comments — — Splinter Review 
See attached diff
Attachment #280776 - Flags: superreview?(cbiesinger)
Attachment #280776 - Flags: review?(benjamin)
Attachment #280776 - Flags: approval1.9?
Comment on attachment 280776 [details] [diff] [review]
Comments

+     * @param segmentSize if zero, use a default segment size, else use the
+     *                    provided size.


I'd suggest a style like:
+     * @param segmentSize
+     *        if zero, use a default segment size, else use the
+     *        provided size.

Also, you can have an infinite pipe. The docs ought to mention that. (compare the docs for NS_NewPipe2/3)
Attachment #280776 - Flags: superreview?(cbiesinger) → superreview+
OS: Linux → All
Hardware: PC → All
Will do.  In fact, I will just copy the wording from those in general...
Attachment #280776 - Flags: review?(benjamin)
Attachment #280776 - Flags: review+
Attachment #280776 - Flags: approval1.9?
Attachment #280776 - Flags: approval1.9+
Checked in, with the comments more like NS_NewPipe(2).
Status: NEW → RESOLVED
Closed: 17 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: