docs: Move the GFileDescriptorBased SECTION

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-23 14:37:35 +01:00
parent 7e15d56013
commit 0576e82e9a
2 changed files with 5 additions and 12 deletions

View File

@ -26,20 +26,18 @@
/** /**
* SECTION:gfiledescriptorbased * GFileDescriptorBased:
* @short_description: Interface for file descriptor based IO
* @include: gio/gfiledescriptorbased.h
* @see_also: #GInputStream, #GOutputStream
* *
* #GFileDescriptorBased is implemented by streams (implementations of * `GFileDescriptorBased` is an interface for file descriptor based IO.
* #GInputStream or #GOutputStream) that are based on file descriptors. *
* It is implemented by streams (implementations of [class@Gio.InputStream] or
* [class@Gio.OutputStream]) that are based on file descriptors.
* *
* Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific * Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config * GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it. * file when using it.
* *
* Since: 2.24 * Since: 2.24
*
**/ **/
typedef GFileDescriptorBasedIface GFileDescriptorBasedInterface; typedef GFileDescriptorBasedIface GFileDescriptorBasedInterface;

View File

@ -33,11 +33,6 @@ G_BEGIN_DECLS
#define G_FILE_DESCRIPTOR_BASED_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBasedIface)) #define G_FILE_DESCRIPTOR_BASED_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE_DESCRIPTOR_BASED, GFileDescriptorBasedIface))
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GFileDescriptorBased, g_object_unref) G_DEFINE_AUTOPTR_CLEANUP_FUNC(GFileDescriptorBased, g_object_unref)
/**
* GFileDescriptorBased:
*
* An interface for file descriptor based io objects.
**/
typedef struct _GFileDescriptorBasedIface GFileDescriptorBasedIface; typedef struct _GFileDescriptorBasedIface GFileDescriptorBasedIface;
/** /**