luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GSeekable SECTION

Browse Source 
Move it 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:56:19 +01:00
parent bea92c4882
commit 0d39a138c7
2 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gio/gseekable.c
View File

@ -26,25 +26,22 @@
/** /**
* SECTION:gseekable * GSeekable:
* @short_description: Stream seeking interface
* @include: gio/gio.h
* @see_also: #GInputStream, #GOutputStream
* *
* #GSeekable is implemented by streams (implementations of * `GSeekable` is implemented by streams (implementations of
* #GInputStream or #GOutputStream) that support seeking. * [class@Gio.InputStream] or [class@Gio.OutputStream]) that support seeking.
* *
* Seekable streams largely fall into two categories: resizable and * Seekable streams largely fall into two categories: resizable and
* fixed-size. * fixed-size.
* *
* #GSeekable on fixed-sized streams is approximately the same as POSIX * `GSeekable` on fixed-sized streams is approximately the same as POSIX
* lseek() on a block device (for example: attempting to seek past the * [`lseek()`](man:lseek(2)) on a block device (for example: attempting to seek
* end of the device is an error). Fixed streams typically cannot be * past the end of the device is an error). Fixed streams typically cannot be
* truncated. * truncated.
* *
* #GSeekable on resizable streams is approximately the same as POSIX * `GSeekable` on resizable streams is approximately the same as POSIX
* lseek() on a normal file. Seeking past the end and writing data will * [`lseek()`](man:lseek(2)) on a normal file. Seeking past the end and writing
* usually cause the stream to resize by introducing zero bytes. * data will usually cause the stream to resize by introducing zero bytes.
**/ **/
typedef GSeekableIface GSeekableInterface; typedef GSeekableIface GSeekableInterface;

5
gio/gseekable.h
View File

@ -36,11 +36,6 @@ G_BEGIN_DECLS
#define G_IS_SEEKABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SEEKABLE)) #define G_IS_SEEKABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SEEKABLE))
#define G_SEEKABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SEEKABLE, GSeekableIface)) #define G_SEEKABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SEEKABLE, GSeekableIface))
/**
* GSeekable:
*
* Seek object for streaming operations.
**/
typedef struct _GSeekableIface GSeekableIface; typedef struct _GSeekableIface GSeekableIface;
/** /**