[svn:parrot] r38732 - trunk/src/io

[whiteknight at svn.parrot.org]

Author: whiteknight
Date: Wed May 13 00:57:03 2009
New Revision: 38732
URL: https://trac.parrot.org/parrot/changeset/38732

Log:
[docs] add some function-level documentation for functions in src/io/* that needed it

Modified:
   trunk/src/io/io_string.c
   trunk/src/io/socket_api.c
   trunk/src/io/socket_unix.c
   trunk/src/io/socket_win32.c

Modified: trunk/src/io/io_string.c
==============================================================================
--- trunk/src/io/io_string.c	Wed May 13 00:47:59 2009	(r38731)
+++ trunk/src/io/io_string.c	Wed May 13 00:57:03 2009	(r38732)
@@ -95,6 +95,8 @@
 
 =item C<ParrotIOLayer * PIO_string_register_layer(void)>
 
+Get  a pointer to the C<pio_string_layer> structure.
+
 =cut
 
 */
@@ -112,6 +114,8 @@
 =item C<static size_t PIO_string_read(PARROT_INTERP, ParrotIOLayer *l,
 ParrotIO *io, STRING **buf)>
 
+Read a string from layer C<l> and store it in the specified buffer.
+
 =cut
 
 */
@@ -132,6 +136,8 @@
 
 =item C<static size_t PIO_string_write(PARROT_INTERP, ParrotIOLayer *l, ParrotIO *io, STRING *s)>
 
+Write the string C<s> to the layer C<l>.
+
 =cut
 
 */

Modified: trunk/src/io/socket_api.c
==============================================================================
--- trunk/src/io/socket_api.c	Wed May 13 00:47:59 2009	(r38731)
+++ trunk/src/io/socket_api.c	Wed May 13 00:57:03 2009	(r38732)
@@ -31,6 +31,8 @@
 
 =item C<INTVAL Parrot_io_socket_is_closed(PMC *socket)>
 
+Returns 1 if the socket is closed, 0 if it is open.
+
 =cut
 
 */

Modified: trunk/src/io/socket_unix.c
==============================================================================
--- trunk/src/io/socket_unix.c	Wed May 13 00:47:59 2009	(r38731)
+++ trunk/src/io/socket_unix.c	Wed May 13 00:57:03 2009	(r38732)
@@ -442,6 +442,9 @@
 =item C<static void get_sockaddr_in(PARROT_INTERP, PMC * sockaddr, const char*
 host, int port)>
 
+Get a new C<sockaddr_in> structure for the given PMC to connect to the
+specified host and port.
+
 =cut
 
 */

Modified: trunk/src/io/socket_win32.c
==============================================================================
--- trunk/src/io/socket_win32.c	Wed May 13 00:47:59 2009	(r38731)
+++ trunk/src/io/socket_win32.c	Wed May 13 00:57:03 2009	(r38732)
@@ -388,6 +388,8 @@
 =item C<static void get_sockaddr_in(PARROT_INTERP, PMC * sockaddr, const char*
 host, int port)>
 
+Get a C<sockaddr_in> structure to connect to the given host.
+
 =cut
 
 */
@@ -428,6 +430,8 @@
 
 =item C<PMC * Parrot_io_sockaddr_in(PARROT_INTERP, STRING *addr, INTVAL port)>
 
+Create a new Sockaddr PMC to connect to the given address and port.
+
 =cut
 
 */