@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gio/unix-connection.d.ts

@@ -2,15 +2,127 @@ import { AsyncResult } from "./async-result.js";
 import { Cancellable } from "./cancellable.js";
 import { Credentials } from "./credentials.js";
 import { SocketConnection } from "./socket-connection.js";
+/**
+ * This is the subclass of [class@Gio.SocketConnection] that is created
+ * for UNIX domain sockets.
+ *
+ * It contains functions to do some of the UNIX socket specific
+ * functionality like passing file descriptors.
+ *
+ * Since GLib 2.72, `GUnixConnection` is available on all platforms. It requires
+ * underlying system support (such as Windows 10 with `AF_UNIX`) at run time.
+ *
+ * Before GLib 2.72, `<gio/gunixconnection.h>` belonged to the UNIX-specific GIO
+ * interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when
+ * using it. This is no longer necessary since GLib 2.72.
+ */
 export declare class UnixConnection extends SocketConnection {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Receives credentials from the sending end of the connection.  The
+     * sending end has to call g_unix_connection_send_credentials() (or
+     * similar) for this to work.
+     *
+     * As well as reading the credentials this also reads (and discards) a
+     * single byte from the stream, as this is required for credentials
+     * passing to work on some implementations.
+     *
+     * This method can be expected to be available on the following platforms:
+     *
+     * - Linux since GLib 2.26
+     * - FreeBSD since GLib 2.26
+     * - GNU/kFreeBSD since GLib 2.36
+     * - Solaris, Illumos and OpenSolaris since GLib 2.40
+     * - GNU/Hurd since GLib 2.40
+     *
+     * Other ways to exchange credentials with a foreign peer includes the
+     * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
+     * @param cancellable - A #GCancellable or %NULL.
+     */
     receiveCredentials(cancellable?: Cancellable | null): Credentials;
+    /**
+     * Asynchronously receive credentials.
+     *
+     * For more details, see g_unix_connection_receive_credentials() which is
+     * the synchronous version of this call.
+     *
+     * When the operation is finished, `callback` will be called. You can then call
+     * g_unix_connection_receive_credentials_finish() to get the result of the operation.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback
+     * @param userData - the data to pass to callback function
+     */
     receiveCredentialsAsync(cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes an asynchronous receive credentials operation started with
+     * g_unix_connection_receive_credentials_async().
+     * @param result - a #GAsyncResult.
+     */
     receiveCredentialsFinish(result: AsyncResult): Credentials;
+    /**
+     * Receives a file descriptor from the sending end of the connection.
+     * The sending end has to call g_unix_connection_send_fd() for this
+     * to work.
+     *
+     * As well as reading the fd this also reads a single byte from the
+     * stream, as this is required for fd passing to work on some
+     * implementations.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore
+     */
     receiveFd(cancellable?: Cancellable | null): number;
+    /**
+     * Passes the credentials of the current user the receiving side
+     * of the connection. The receiving end has to call
+     * g_unix_connection_receive_credentials() (or similar) to accept the
+     * credentials.
+     *
+     * As well as sending the credentials this also writes a single NUL
+     * byte to the stream, as this is required for credentials passing to
+     * work on some implementations.
+     *
+     * This method can be expected to be available on the following platforms:
+     *
+     * - Linux since GLib 2.26
+     * - FreeBSD since GLib 2.26
+     * - GNU/kFreeBSD since GLib 2.36
+     * - Solaris, Illumos and OpenSolaris since GLib 2.40
+     * - GNU/Hurd since GLib 2.40
+     *
+     * Other ways to exchange credentials with a foreign peer includes the
+     * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
+     * @param cancellable - A #GCancellable or %NULL.
+     */
     sendCredentials(cancellable?: Cancellable | null): boolean;
+    /**
+     * Asynchronously send credentials.
+     *
+     * For more details, see g_unix_connection_send_credentials() which is
+     * the synchronous version of this call.
+     *
+     * When the operation is finished, `callback` will be called. You can then call
+     * g_unix_connection_send_credentials_finish() to get the result of the operation.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback
+     * @param userData - the data to pass to callback function
+     */
     sendCredentialsAsync(cancellable?: Cancellable | null, callback?: (...args: unknown[]) => unknown | null, userData?: number | null): void;
+    /**
+     * Finishes an asynchronous send credentials operation started with
+     * g_unix_connection_send_credentials_async().
+     * @param result - a #GAsyncResult.
+     */
     sendCredentialsFinish(result: AsyncResult): boolean;
+    /**
+     * Passes a file descriptor to the receiving side of the
+     * connection. The receiving end has to call g_unix_connection_receive_fd()
+     * to accept the file descriptor.
+     *
+     * As well as sending the fd this also writes a single byte to the
+     * stream, as this is required for fd passing to work on some
+     * implementations.
+     * @param fd - a file descriptor
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     sendFd(fd: number, cancellable?: Cancellable | null): boolean;
 }

package/dist/generated/gio/unix-connection.js

@@ -2,6 +2,20 @@ import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import { Credentials } from "./credentials.js";
 import { SocketConnection } from "./socket-connection.js";
+/**
+ * This is the subclass of [class@Gio.SocketConnection] that is created
+ * for UNIX domain sockets.
+ *
+ * It contains functions to do some of the UNIX socket specific
+ * functionality like passing file descriptors.
+ *
+ * Since GLib 2.72, `GUnixConnection` is available on all platforms. It requires
+ * underlying system support (such as Windows 10 with `AF_UNIX`) at run time.
+ *
+ * Before GLib 2.72, `<gio/gunixconnection.h>` belonged to the UNIX-specific GIO
+ * interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when
+ * using it. This is no longer necessary since GLib 2.72.
+ */
 export class UnixConnection extends SocketConnection {
     constructor(...args) {
         super(...args);
@@ -17,6 +31,27 @@ export class UnixConnection extends SocketConnection {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Receives credentials from the sending end of the connection.  The
+     * sending end has to call g_unix_connection_send_credentials() (or
+     * similar) for this to work.
+     *
+     * As well as reading the credentials this also reads (and discards) a
+     * single byte from the stream, as this is required for credentials
+     * passing to work on some implementations.
+     *
+     * This method can be expected to be available on the following platforms:
+     *
+     * - Linux since GLib 2.26
+     * - FreeBSD since GLib 2.26
+     * - GNU/kFreeBSD since GLib 2.36
+     * - Solaris, Illumos and OpenSolaris since GLib 2.40
+     * - GNU/Hurd since GLib 2.40
+     *
+     * Other ways to exchange credentials with a foreign peer includes the
+     * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
+     * @param cancellable - A #GCancellable or %NULL.
+     */
     receiveCredentials(cancellable) {
         const error = { value: null };
         const ptr = call("libgio-2.0.so.0", "g_unix_connection_receive_credentials", [
@@ -46,6 +81,18 @@ export class UnixConnection extends SocketConnection {
         }
         return getObject(ptr, Credentials);
     }
+    /**
+     * Asynchronously receive credentials.
+     *
+     * For more details, see g_unix_connection_receive_credentials() which is
+     * the synchronous version of this call.
+     *
+     * When the operation is finished, `callback` will be called. You can then call
+     * g_unix_connection_receive_credentials_finish() to get the result of the operation.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback
+     * @param userData - the data to pass to callback function
+     */
     receiveCredentialsAsync(cancellable, callback, userData) {
         call("libgio-2.0.so.0", "g_unix_connection_receive_credentials_async", [
             {
@@ -69,6 +116,11 @@ export class UnixConnection extends SocketConnection {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Finishes an asynchronous receive credentials operation started with
+     * g_unix_connection_receive_credentials_async().
+     * @param result - a #GAsyncResult.
+     */
     receiveCredentialsFinish(result) {
         const error = { value: null };
         const ptr = call("libgio-2.0.so.0", "g_unix_connection_receive_credentials_finish", [
@@ -97,6 +149,16 @@ export class UnixConnection extends SocketConnection {
         }
         return getObject(ptr, Credentials);
     }
+    /**
+     * Receives a file descriptor from the sending end of the connection.
+     * The sending end has to call g_unix_connection_send_fd() for this
+     * to work.
+     *
+     * As well as reading the fd this also reads a single byte from the
+     * stream, as this is required for fd passing to work on some
+     * implementations.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore
+     */
     receiveFd(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_unix_connection_receive_fd", [
@@ -126,6 +188,28 @@ export class UnixConnection extends SocketConnection {
         }
         return result;
     }
+    /**
+     * Passes the credentials of the current user the receiving side
+     * of the connection. The receiving end has to call
+     * g_unix_connection_receive_credentials() (or similar) to accept the
+     * credentials.
+     *
+     * As well as sending the credentials this also writes a single NUL
+     * byte to the stream, as this is required for credentials passing to
+     * work on some implementations.
+     *
+     * This method can be expected to be available on the following platforms:
+     *
+     * - Linux since GLib 2.26
+     * - FreeBSD since GLib 2.26
+     * - GNU/kFreeBSD since GLib 2.36
+     * - Solaris, Illumos and OpenSolaris since GLib 2.40
+     * - GNU/Hurd since GLib 2.40
+     *
+     * Other ways to exchange credentials with a foreign peer includes the
+     * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
+     * @param cancellable - A #GCancellable or %NULL.
+     */
     sendCredentials(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_unix_connection_send_credentials", [
@@ -155,6 +239,18 @@ export class UnixConnection extends SocketConnection {
         }
         return result;
     }
+    /**
+     * Asynchronously send credentials.
+     *
+     * For more details, see g_unix_connection_send_credentials() which is
+     * the synchronous version of this call.
+     *
+     * When the operation is finished, `callback` will be called. You can then call
+     * g_unix_connection_send_credentials_finish() to get the result of the operation.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - a #GAsyncReadyCallback
+     * @param userData - the data to pass to callback function
+     */
     sendCredentialsAsync(cancellable, callback, userData) {
         call("libgio-2.0.so.0", "g_unix_connection_send_credentials_async", [
             {
@@ -178,6 +274,11 @@ export class UnixConnection extends SocketConnection {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Finishes an asynchronous send credentials operation started with
+     * g_unix_connection_send_credentials_async().
+     * @param result - a #GAsyncResult.
+     */
     sendCredentialsFinish(result) {
         const error = { value: null };
         const _result = call("libgio-2.0.so.0", "g_unix_connection_send_credentials_finish", [
@@ -206,6 +307,17 @@ export class UnixConnection extends SocketConnection {
         }
         return _result;
     }
+    /**
+     * Passes a file descriptor to the receiving side of the
+     * connection. The receiving end has to call g_unix_connection_receive_fd()
+     * to accept the file descriptor.
+     *
+     * As well as sending the fd this also writes a single byte to the
+     * stream, as this is required for fd passing to work on some
+     * implementations.
+     * @param fd - a file descriptor
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     sendFd(fd, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_unix_connection_send_fd", [

package/dist/generated/gio/unix-credentials-message.d.ts

@@ -1,9 +1,43 @@
 import { Credentials } from "./credentials.js";
 import { SocketControlMessage } from "./socket-control-message.js";
+/**
+ * This [class@Gio.SocketControlMessage] contains a [class@Gio.Credentials]
+ * instance.  It may be sent using [method@Gio.Socket.send_message] and received
+ * using [method@Gio.Socket.receive_message] over UNIX sockets (ie: sockets in
+ * the `G_SOCKET_FAMILY_UNIX` family).
+ *
+ * For an easier way to send and receive credentials over
+ * stream-oriented UNIX sockets, see
+ * [method@Gio.UnixConnection.send_credentials] and
+ * [method@Gio.UnixConnection.receive_credentials]. To receive credentials of
+ * a foreign process connected to a socket, use
+ * [method@Gio.Socket.get_credentials].
+ *
+ * Since GLib 2.72, `GUnixCredentialMessage` is available on all platforms. It
+ * requires underlying system support (such as Windows 10 with `AF_UNIX`) at run
+ * time.
+ *
+ * Before GLib 2.72, `<gio/gunixcredentialsmessage.h>` belonged to the UNIX-specific
+ * GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file
+ * when using it. This is no longer necessary since GLib 2.72.
+ */
 export declare class UnixCredentialsMessage extends SocketControlMessage {
+    /**
+     * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
+     */
     constructor(...args: unknown[]);
+    /**
+     * Creates a new #GUnixCredentialsMessage holding @credentials.
+     * @param credentials - A #GCredentials object.
+     */
     static credentialsMessageNewWithCredentials(credentials: Credentials): UnixCredentialsMessage;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Checks if passing #GCredentials on a #GSocket is supported on this platform.
+     */
     static isSupported(): boolean;
+    /**
+     * Gets the credentials stored in @message.
+     */
     getCredentials(): Credentials;
 }

package/dist/generated/gio/unix-credentials-message.js

@@ -2,10 +2,38 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Credentials } from "./credentials.js";
 import { SocketControlMessage } from "./socket-control-message.js";
+/**
+ * This [class@Gio.SocketControlMessage] contains a [class@Gio.Credentials]
+ * instance.  It may be sent using [method@Gio.Socket.send_message] and received
+ * using [method@Gio.Socket.receive_message] over UNIX sockets (ie: sockets in
+ * the `G_SOCKET_FAMILY_UNIX` family).
+ *
+ * For an easier way to send and receive credentials over
+ * stream-oriented UNIX sockets, see
+ * [method@Gio.UnixConnection.send_credentials] and
+ * [method@Gio.UnixConnection.receive_credentials]. To receive credentials of
+ * a foreign process connected to a socket, use
+ * [method@Gio.Socket.get_credentials].
+ *
+ * Since GLib 2.72, `GUnixCredentialMessage` is available on all platforms. It
+ * requires underlying system support (such as Windows 10 with `AF_UNIX`) at run
+ * time.
+ *
+ * Before GLib 2.72, `<gio/gunixcredentialsmessage.h>` belonged to the UNIX-specific
+ * GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file
+ * when using it. This is no longer necessary since GLib 2.72.
+ */
 export class UnixCredentialsMessage extends SocketControlMessage {
+    /**
+     * Creates a new #GUnixCredentialsMessage with credentials matching the current processes.
+     */
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new #GUnixCredentialsMessage holding @credentials.
+     * @param credentials - A #GCredentials object.
+     */
     static credentialsMessageNewWithCredentials(credentials) {
         const ptr = call("libgio-2.0.so.0", "g_unix_credentials_message_new_with_credentials", [
             {
@@ -21,9 +49,15 @@ export class UnixCredentialsMessage extends SocketControlMessage {
             borrowed: false,
         });
     }
+    /**
+     * Checks if passing #GCredentials on a #GSocket is supported on this platform.
+     */
     static isSupported() {
         return call("libgio-2.0.so.0", "g_unix_credentials_message_is_supported", [], { type: "boolean" });
     }
+    /**
+     * Gets the credentials stored in @message.
+     */
     getCredentials() {
         const ptr = call("libgio-2.0.so.0", "g_unix_credentials_message_get_credentials", [
             {

package/dist/generated/gio/unix-fdlist.d.ts

@@ -1,13 +1,115 @@
 import { Ref } from "@gtkx/native";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `GUnixFDList` contains a list of file descriptors.  It owns the file
+ * descriptors that it contains, closing them when finalized.
+ *
+ * It may be wrapped in a
+ * `GUnixFDMessage` and sent over a
+ * [class@Gio.Socket] in the `G_SOCKET_FAMILY_UNIX` family by using
+ * [method@Gio.Socket.send_message] and received using
+ * [method@Gio.Socket.receive_message].
+ *
+ * Before 2.74, `<gio/gunixfdlist.h>` belonged to the UNIX-specific GIO
+ * interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when
+ * using it.
+ *
+ * Since 2.74, the API is available for Windows.
+ */
 export declare class UnixFDList extends GObject.GObject {
+    /**
+     * Creates a new #GUnixFDList containing no file descriptors.
+     */
     constructor(...args: unknown[]);
+    /**
+     * Creates a new #GUnixFDList containing the file descriptors given in
+     * @fds.  The file descriptors become the property of the new list and
+     * may no longer be used by the caller.  The array itself is owned by
+     * the caller.
+     *
+     * Each file descriptor in the array should be set to close-on-exec.
+     *
+     * If `n_fds` is -1 then `fds` must be terminated with -1.
+     * @param fds - the initial list of file descriptors
+     * @param nFds - the length of #fds, or -1
+     */
     static fdListNewFromArray(fds: number[], nFds: number): UnixFDList;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Adds a file descriptor to @list.
+     *
+     * The file descriptor is duplicated using dup(). You keep your copy
+     * of the descriptor and the copy contained in `list` will be closed
+     * when `list` is finalized.
+     *
+     * A possible cause of failure is exceeding the per-process or
+     * system-wide file descriptor limit.
+     *
+     * The index of the file descriptor in the list is returned.  If you use
+     * this index with g_unix_fd_list_get() then you will receive back a
+     * duplicated copy of the same file descriptor.
+     * @param fd - a valid open file descriptor
+     */
     append(fd: number): number;
+    /**
+     * Gets a file descriptor out of @list.
+     *
+     * `index_` specifies the index of the file descriptor to get.  It is a
+     * programmer error for `index_` to be out of range; see
+     * g_unix_fd_list_get_length().
+     *
+     * The file descriptor is duplicated using dup() and set as
+     * close-on-exec before being returned.  You must call close() on it
+     * when you are done.
+     *
+     * A possible cause of failure is exceeding the per-process or
+     * system-wide file descriptor limit.
+     * @param index_ - the index into the list
+     */
     get(index_: number): number;
+    /**
+     * Gets the length of `list` (ie: the number of file descriptors
+     * contained within).
+     */
     getLength(): number;
+    /**
+     * Returns the array of file descriptors that is contained in this
+     * object.
+     *
+     * After this call, the descriptors remain the property of @list.  The
+     * caller must not close them and must not free the array.  The array is
+     * valid only until `list` is changed in any way.
+     *
+     * If `length` is non-%NULL then it is set to the number of file
+     * descriptors in the returned array. The returned array is also
+     * terminated with -1.
+     *
+     * This function never returns %NULL. In case there are no file
+     * descriptors contained in @list, an empty array is returned.
+     * @param length - pointer to the length of the returned
+     */
     peekFds(length?: Ref<number> | null): number[];
+    /**
+     * Returns the array of file descriptors that is contained in this
+     * object.
+     *
+     * After this call, the descriptors are no longer contained in
+     * @list. Further calls will return an empty list (unless more
+     * descriptors have been added).
+     *
+     * The return result of this function must be freed with g_free().
+     * The caller is also responsible for closing all of the file
+     * descriptors.  The file descriptors in the array are set to
+     * close-on-exec.
+     *
+     * If `length` is non-%NULL then it is set to the number of file
+     * descriptors in the returned array. The returned array is also
+     * terminated with -1.
+     *
+     * This function never returns %NULL. In case there are no file
+     * descriptors contained in @list, an empty array is returned.
+     * @param length - pointer to the length of the returned
+     */
     stealFds(length?: Ref<number> | null): number[];
     connect(signal: "notify", handler: (self: UnixFDList, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gio/unix-fdlist.js

@@ -1,10 +1,41 @@
 import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+/**
+ * A `GUnixFDList` contains a list of file descriptors.  It owns the file
+ * descriptors that it contains, closing them when finalized.
+ *
+ * It may be wrapped in a
+ * `GUnixFDMessage` and sent over a
+ * [class@Gio.Socket] in the `G_SOCKET_FAMILY_UNIX` family by using
+ * [method@Gio.Socket.send_message] and received using
+ * [method@Gio.Socket.receive_message].
+ *
+ * Before 2.74, `<gio/gunixfdlist.h>` belonged to the UNIX-specific GIO
+ * interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when
+ * using it.
+ *
+ * Since 2.74, the API is available for Windows.
+ */
 export class UnixFDList extends GObject.GObject {
+    /**
+     * Creates a new #GUnixFDList containing no file descriptors.
+     */
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new #GUnixFDList containing the file descriptors given in
+     * @fds.  The file descriptors become the property of the new list and
+     * may no longer be used by the caller.  The array itself is owned by
+     * the caller.
+     *
+     * Each file descriptor in the array should be set to close-on-exec.
+     *
+     * If `n_fds` is -1 then `fds` must be terminated with -1.
+     * @param fds - the initial list of file descriptors
+     * @param nFds - the length of #fds, or -1
+     */
     static fdListNewFromArray(fds, nFds) {
         const ptr = call("libgio-2.0.so.0", "g_unix_fd_list_new_from_array", [
             {
@@ -27,6 +58,21 @@ export class UnixFDList extends GObject.GObject {
             borrowed: false,
         });
     }
+    /**
+     * Adds a file descriptor to @list.
+     *
+     * The file descriptor is duplicated using dup(). You keep your copy
+     * of the descriptor and the copy contained in `list` will be closed
+     * when `list` is finalized.
+     *
+     * A possible cause of failure is exceeding the per-process or
+     * system-wide file descriptor limit.
+     *
+     * The index of the file descriptor in the list is returned.  If you use
+     * this index with g_unix_fd_list_get() then you will receive back a
+     * duplicated copy of the same file descriptor.
+     * @param fd - a valid open file descriptor
+     */
     append(fd) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_unix_fd_list_append", [
@@ -55,6 +101,21 @@ export class UnixFDList extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * Gets a file descriptor out of @list.
+     *
+     * `index_` specifies the index of the file descriptor to get.  It is a
+     * programmer error for `index_` to be out of range; see
+     * g_unix_fd_list_get_length().
+     *
+     * The file descriptor is duplicated using dup() and set as
+     * close-on-exec before being returned.  You must call close() on it
+     * when you are done.
+     *
+     * A possible cause of failure is exceeding the per-process or
+     * system-wide file descriptor limit.
+     * @param index_ - the index into the list
+     */
     get(index_) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_unix_fd_list_get", [
@@ -83,6 +144,10 @@ export class UnixFDList extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * Gets the length of `list` (ie: the number of file descriptors
+     * contained within).
+     */
     getLength() {
         return call("libgio-2.0.so.0", "g_unix_fd_list_get_length", [
             {
@@ -91,6 +156,22 @@ export class UnixFDList extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the array of file descriptors that is contained in this
+     * object.
+     *
+     * After this call, the descriptors remain the property of @list.  The
+     * caller must not close them and must not free the array.  The array is
+     * valid only until `list` is changed in any way.
+     *
+     * If `length` is non-%NULL then it is set to the number of file
+     * descriptors in the returned array. The returned array is also
+     * terminated with -1.
+     *
+     * This function never returns %NULL. In case there are no file
+     * descriptors contained in @list, an empty array is returned.
+     * @param length - pointer to the length of the returned
+     */
     peekFds(length) {
         return call("libgio-2.0.so.0", "g_unix_fd_list_peek_fds", [
             {
@@ -107,6 +188,27 @@ export class UnixFDList extends GObject.GObject {
             },
         ], { type: "array", itemType: { type: "int", size: 32, unsigned: false } });
     }
+    /**
+     * Returns the array of file descriptors that is contained in this
+     * object.
+     *
+     * After this call, the descriptors are no longer contained in
+     * @list. Further calls will return an empty list (unless more
+     * descriptors have been added).
+     *
+     * The return result of this function must be freed with g_free().
+     * The caller is also responsible for closing all of the file
+     * descriptors.  The file descriptors in the array are set to
+     * close-on-exec.
+     *
+     * If `length` is non-%NULL then it is set to the number of file
+     * descriptors in the returned array. The returned array is also
+     * terminated with -1.
+     *
+     * This function never returns %NULL. In case there are no file
+     * descriptors contained in @list, an empty array is returned.
+     * @param length - pointer to the length of the returned
+     */
     stealFds(length) {
         return call("libgio-2.0.so.0", "g_unix_fd_list_steal_fds", [
             {