Bug 3751 - ACE_Pipe::recv doxygen documentation error
Summary: ACE_Pipe::recv doxygen documentation error
Status: NEW
Alias: None
Product: ACE
Classification: Unclassified
Component: ACE Documentation (show other bugs)
Version: 5.6.9
Hardware: All All
: P3 trivial
Assignee: DOC Center Support List (internal)
URL:
Depends on:
Blocks:
 
Reported: 2009-10-23 12:13 CDT by Matt Carter
Modified: 2009-10-23 12:13 CDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Matt Carter 2009-10-23 12:13:30 CDT
The doxygen documentation for the varargs recv method on the ACE_Pipe class does not make sense.

The documentations states:
     This is an interface to ::readv, that doesn't use the struct
     iovec explicitly.  The ... can be passed as an arbitrary number
     of (char *ptr, int len) tuples.  However, the count N is the
     *total* number of trailing arguments, *not* a couple of the
     number of tuple pairs!

In my e-mail to the ace-bugs mailing list, I proposed changing the last few words to:
     "*not* the number of tuples!"

Doug Schmidt replied proposing this wording:
     "*not* a count of the number of tuple pairs!"

That's fine with me.

Looking further, I see that the same documentation appears in a few other files:
./ACE.cpp
./DEV_IO.cpp
./DEV_IO.h
./FILE_IO.cpp
./FILE_IO.h
./MEM_IO.cpp
./Pipe.cpp
./Pipe.h
./SOCK_IO.cpp
./SPIPE_Stream.cpp
./SPIPE_Stream.h