luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-02 07:23:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GPolllable*Stream SECTIONs

Browse Source 
Move them to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall
2023-10-24 10:54:52 +01:00
parent ed34ddc355
commit d9e35c264b
4 changed files with 10 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
gio/gpollableoutputstream.c
View File

@@ -28,19 +28,16 @@
#include "glibintl.h"
/**
* SECTION:gpollableoutputstream
* @short_description: Interface for pollable output streams
* @include: gio/gio.h
* @see_also: #GOutputStream, #GFileDescriptorBased, #GPollableInputStream
* GPollableOutputStream:
*
* #GPollableOutputStream is implemented by #GOutputStreams that
* `GPollableOutputStream` is implemented by [class@Gio.OutputStream]s that
* can be polled for readiness to write. This can be used when
* interfacing with a non-GIO API that expects
* UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.
*
* Some classes may implement #GPollableOutputStream but have only certain
* instances of that class be pollable. If g_pollable_output_stream_can_poll()
* returns %FALSE, then the behavior of other #GPollableOutputStream methods is
* Some classes may implement `GPollableOutputStream` but have only certain
* instances of that class be pollable. If [method@Gio.PollableOutputStream.can_poll]
* returns false, then the behavior of other `GPollableOutputStream` methods is
* undefined.
*
* Since: 2.28