Bug 262 – Missing DDoc comments in on Socket.blocking

Status
RESOLVED
Resolution
FIXED
Severity
normal
Priority
P2
Component
phobos
Product
D
Version
D1 (retired)
Platform
x86
OS
All
Creation time
2006-07-21T02:45:00Z
Last change time
2014-02-15T13:24:58Z
Assigned to
bugzilla
Creator
aldacron

Comments

Comment #0 by aldacron — 2006-07-21T02:45:54Z
Both the getter and the setter for the blocking property of Socket are missing DDoc comments. When reading the documentation, this makes it seem as if there is no way to configure a socket in blocking/non-blocking mode.
Comment #1 by bugs-d — 2006-07-23T14:45:16Z
Something like this? /// The socket's blocking flag. /// When a socket is blocking, calls to receive(), accept(), and send() will block and wait for data/action. /// A non-blocking socket will immediately return instead of blocking. bool blocking() // getter /// ditto void blocking(bool byes) // setter Too much, or not enough information? Thanks, -[Unknown] > [email protected] wrote: >> Both the getter and the setter for the blocking property of Socket are >> missing >> DDoc comments. When reading the documentation, this makes it seem as >> if there >> is no way to configure a socket in blocking/non-blocking mode. > > > I know nothing about sockets. Can you provide some comments I can just > paste in?
Comment #2 by chris — 2006-07-23T15:30:19Z
It looks like when Ddoc comments were added, the blocking documentation was added to the wrong element (_blocking (Windows only) instead of blocking() (there are 2 for get/set, one needs a ditto)). There also seems to be other missing ddoc comments, such as SocketSet.max (which should be documented in the old doc), and a few constructors (e.g. the exceptions) do not show what the parameters are (simple /// by them should be enough). On Sun, 23 Jul 2006 15:41:12 -0400, Unknown W. Brackets <[email protected]> wrote: > Something like this? > > /// The socket's blocking flag. > /// When a socket is blocking, calls to receive(), accept(), and send() > will block and wait for data/action. > /// A non-blocking socket will immediately return instead of blocking. > bool blocking() // getter > > /// ditto > void blocking(bool byes) // setter > > Too much, or not enough information? > > Thanks, > -[Unknown] > > >> [email protected] wrote: >>> Both the getter and the setter for the blocking property of Socket are >>> missing >>> DDoc comments. When reading the documentation, this makes it seem as >>> if there >>> is no way to configure a socket in blocking/non-blocking mode. >> I know nothing about sockets. Can you provide some comments I can >> just paste in?
Comment #3 by bugzilla — 2006-08-11T19:14:59Z
Fixed DMD 0.164 (added suggested documentation)