If you think a bug might affect users in the 57 release, please set the correct tracking and status flags for Release Management.

[FIX]Better docs for nsIPipe.init

RESOLVED FIXED in mozilla1.9beta1

Status

()

Core
XPCOM
RESOLVED FIXED
10 years ago
10 years ago

People

(Reporter: bz, Assigned: bz)

Tracking

Trunk
mozilla1.9beta1
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

Created attachment 280776 [details] [diff] [review]
Comments

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...

Updated

10 years ago
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
Last Resolved: 10 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.