diff options
| author | Andrew Walton <awalton@src.gnome.org> | 2007-11-27 14:00:13 +0000 |
|---|---|---|
| committer | Andrew Walton <awalton@src.gnome.org> | 2007-11-27 14:00:13 +0000 |
| commit | 5247f12f3649726471080440de0d37b78c1cec33 (patch) | |
| tree | 69bd070ba8cb8b12234319e354f5cb856d0c551f /gio/gsocketoutputstream.c | |
| parent | 6d071b4ab6d60aecf9532d1aac2128dd0c08f917 (diff) | |
| download | glib-5247f12f3649726471080440de0d37b78c1cec33.tar.gz | |
Bumps documentation to 93% symbol coverage, touching most
of the public files. Fixes broken function documentation prototypes.
Fixes GCancellable inaccuracies. Removes unnecessary incomplete
gtk-doc headers in private files.
svn path=/trunk/; revision=5953
Diffstat (limited to 'gio/gsocketoutputstream.c')
| -rw-r--r-- | gio/gsocketoutputstream.c | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/gio/gsocketoutputstream.c b/gio/gsocketoutputstream.c index 54539f589..b42162feb 100644 --- a/gio/gsocketoutputstream.c +++ b/gio/gsocketoutputstream.c @@ -37,9 +37,17 @@ #include "gcancellable.h" #include "gsimpleasyncresult.h" #include "gasynchelper.h" - #include "glibintl.h" +/** + * SECTION:gsocketoutputstream + * @short_description: Socket Output Stream + * @see_also: #GOutputStream. + * + * #GSocketOutputStream implements #GOutputStream for writing to a socket, including + * asynchronous operations. + **/ + G_DEFINE_TYPE (GSocketOutputStream, g_socket_output_stream, G_TYPE_OUTPUT_STREAM); @@ -116,8 +124,11 @@ g_socket_output_stream_init (GSocketOutputStream *socket) /** * g_socket_output_stream_new: - * @fd: file descriptor. - * @close_fd_at_close: boolean value. + * @fd: socket's file descriptor. + * @close_fd_at_close: a #gboolean. + * + * Creates a new socket output stream for @fd. If @close_fd_at_close + * is %TRUE, the socket will be closed when the output stream is destroyed. * * Returns: #GOutputStream. If @close_fd_at_close is %TRUE, then * @fd will be closed when the #GOutputStream is closed. |