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

docs: Move the GFile*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-25 13:11:33 +01:00
parent 6c930587ad
commit 607eb851ba
4 changed files with 14 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
gio/gfileinputstream.c
View File

@ -33,20 +33,17 @@
/**
* SECTION:gfileinputstream
* @short_description: File input streaming operations
* @include: gio/gio.h
* @see_also: #GInputStream, #GDataInputStream, #GSeekable
* GFileInputStream:
*
* GFileInputStream provides input streams that take their
* `GFileInputStream` provides input streams that take their
* content from a file.
*
* GFileInputStream implements #GSeekable, which allows the input
* `GFileInputStream` implements [iface@Gio.Seekable], which allows the input
* stream to jump to arbitrary positions in the file, provided the
* filesystem of the file allows it. To find the position of a file
* input stream, use g_seekable_tell(). To find out if a file input
* stream supports seeking, use g_seekable_can_seek().
* To position a file input stream, use g_seekable_seek().
* input stream, use [method@Gio.Seekable.tell]. To find out if a file input
* stream supports seeking, use [iface@Gio.Seekable.can_seek].
* To position a file input stream, use [iface@Gio.Seekable.seek].
**/
static void g_file_input_stream_seekable_iface_init (GSeekableIface *iface);

8
gio/gfileinputstream.h
View File

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define G_IS_FILE_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INPUT_STREAM))
#define G_FILE_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
/**
* GFileInputStream:
*
* A subclass of GInputStream for opened files. This adds
* a few file-specific operations and seeking.
*
* #GFileInputStream implements #GSeekable.
**/
typedef struct _GFileInputStreamClass GFileInputStreamClass;
typedef struct _GFileInputStreamPrivate GFileInputStreamPrivate;

19
gio/gfileoutputstream.c
View File

@ -33,25 +33,22 @@
/**
* SECTION:gfileoutputstream
* @short_description: File output streaming operations
* @include: gio/gio.h
* @see_also: #GOutputStream, #GDataOutputStream, #GSeekable
* GFileOutputStream:
*
* GFileOutputStream provides output streams that write their
* `GFileOutputStream` provides output streams that write their
* content to a file.
*
* GFileOutputStream implements #GSeekable, which allows the output
* `GFileOutputStream` implements [iface@Gio.Seekable], which allows the output
* stream to jump to arbitrary positions in the file and to truncate
* the file, provided the filesystem of the file supports these
* operations.
*
* To find the position of a file output stream, use g_seekable_tell().
* To find the position of a file output stream, use [method@Gio.Seekable.tell].
* To find out if a file output stream supports seeking, use
* g_seekable_can_seek().To position a file output stream, use
* g_seekable_seek(). To find out if a file output stream supports
* truncating, use g_seekable_can_truncate(). To truncate a file output
* stream, use g_seekable_truncate().
* [method@Gio.Seekable.can_seek].To position a file output stream, use
* [method@Gio.Seekable.seek]. To find out if a file output stream supports
* truncating, use [method@Gio.Seekable.can_truncate]. To truncate a file output
* stream, use [method@Gio.Seekable.truncate].
**/
static void g_file_output_stream_seekable_iface_init (GSeekableIface *iface);

8
gio/gfileoutputstream.h
View File

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define G_IS_FILE_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
#define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
/**
* GFileOutputStream:
*
* A subclass of GOutputStream for opened files. This adds
* a few file-specific operations and seeking and truncating.
*
* #GFileOutputStream implements GSeekable.
**/
typedef struct _GFileOutputStreamClass GFileOutputStreamClass;
typedef struct _GFileOutputStreamPrivate GFileOutputStreamPrivate;