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

gio: Add various missing property documentation comments

Browse Source 
Previously these properties would have been documented using the strings
from the pspec, but those will be removed in the following commit. Re-add
the documentation using those strings, but as gi-docgen documentation
comments.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #2991
This commit is contained in:
Philip Withnall 2023-11-29 13:23:09 +00:00
parent f6a1599e3c
commit f3aebf0c15
37 changed files with 610 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
gio/gapplication.c
View File

@ -1484,6 +1484,13 @@ g_application_class_init (GApplicationClass *class)
class->dbus_unregister = g_application_real_dbus_unregister;
class->name_lost = g_application_real_name_lost;
/**
* GApplication:application-id:
*
* The unique identifier for the application.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_APPLICATION_ID,
g_param_spec_string ("application-id",
P_("Application identifier"),
@ -1491,6 +1498,13 @@ g_application_class_init (GApplicationClass *class)
NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
* GApplication:flags:
*
* Flags specifying the behaviour of the application.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_FLAGS,
g_param_spec_flags ("flags",
P_("Application flags"),
@ -1498,24 +1512,52 @@ g_application_class_init (GApplicationClass *class)
G_TYPE_APPLICATION_FLAGS, G_APPLICATION_DEFAULT_FLAGS,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GApplication:resource-base-path:
*
* The base resource path for the application.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_RESOURCE_BASE_PATH,
g_param_spec_string ("resource-base-path",
P_("Resource base path"),
P_("The base resource path for the application"),
NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GApplication:is-registered:
*
* Whether [method@Gio.Application.register] has been called.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_IS_REGISTERED,
g_param_spec_boolean ("is-registered",
P_("Is registered"),
P_("If g_application_register() has been called"),
FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GApplication:is-remote:
*
* Whether this application instance is remote.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_IS_REMOTE,
g_param_spec_boolean ("is-remote",
P_("Is remote"),
P_("If this application instance is remote"),
FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GApplication:inactivity-timeout:
*
* Time (in milliseconds) to stay alive after becoming idle.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
g_param_spec_uint ("inactivity-timeout",
P_("Inactivity timeout"),
@ -1523,6 +1565,13 @@ g_application_class_init (GApplicationClass *class)
0, G_MAXUINT, 0,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GApplication:action-group:
*
* The group of actions that the application exports.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_ACTION_GROUP,
g_param_spec_object ("action-group",
P_("Action group"),

29
gio/gapplicationcommandline.c
View File

@ -438,6 +438,14 @@ g_application_command_line_class_init (GApplicationCommandLineClass *class)
class->done = g_application_command_line_real_done;
/**
* GApplicationCommandLine:arguments:
*
* The commandline that caused this [signal@Gio.Application::command-line]
* signal emission.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_ARGUMENTS,
g_param_spec_variant ("arguments",
P_("Commandline arguments"),
@ -446,6 +454,13 @@ g_application_command_line_class_init (GApplicationCommandLineClass *class)
G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GApplicationCommandLine:options:
*
* The options sent along with the commandline.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_OPTIONS,
g_param_spec_variant ("options",
P_("Options"),
@ -453,6 +468,13 @@ g_application_command_line_class_init (GApplicationCommandLineClass *class)
G_VARIANT_TYPE_VARDICT, NULL, G_PARAM_WRITABLE |
G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
/**
* GApplicationCommandLine:platform-data:
*
* Platform-specific data for the commandline.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_PLATFORM_DATA,
g_param_spec_variant ("platform-data",
P_("Platform data"),
@ -461,6 +483,13 @@ g_application_command_line_class_init (GApplicationCommandLineClass *class)
G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GApplicationCommandLine:is-remote:
*
* Whether this is a remote commandline.
*
* Since: 2.28
*/
g_object_class_install_property (object_class, PROP_IS_REMOTE,
g_param_spec_boolean ("is-remote",
P_("Is remote"),

5
gio/gbufferedinputstream.c
View File

@ -157,6 +157,11 @@ g_buffered_input_stream_class_init (GBufferedInputStreamClass *klass)
bstream_class->fill_async = g_buffered_input_stream_real_fill_async;
bstream_class->fill_finish = g_buffered_input_stream_real_fill_finish;
/**
* GBufferedInputStream:buffer-size:
*
* The size of the backend buffer, in bytes.
*/
g_object_class_install_property (object_class,
PROP_BUFSIZE,
g_param_spec_uint ("buffer-size",

10
gio/gbufferedoutputstream.c
View File

@ -145,6 +145,11 @@ g_buffered_output_stream_class_init (GBufferedOutputStreamClass *klass)
ostream_class->close_async = g_buffered_output_stream_close_async;
ostream_class->close_finish = g_buffered_output_stream_close_finish;
/**
* GBufferedOutputStream:buffer-size:
*
* The size of the backend buffer, in bytes.
*/
g_object_class_install_property (object_class,
PROP_BUFSIZE,
g_param_spec_uint ("buffer-size",
@ -156,6 +161,11 @@ g_buffered_output_stream_class_init (GBufferedOutputStreamClass *klass)
G_PARAM_READWRITE|G_PARAM_CONSTRUCT|
G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
/**
* GBufferedOutputStream:auto-grow:
*
* Whether the buffer should automatically grow.
*/
g_object_class_install_property (object_class,
PROP_AUTO_GROW,
g_param_spec_boolean ("auto-grow",

23
gio/gcharsetconverter.c
View File

@ -152,6 +152,13 @@ g_charset_converter_class_init (GCharsetConverterClass *klass)
gobject_class->get_property = g_charset_converter_get_property;
gobject_class->set_property = g_charset_converter_set_property;
/**
* GCharsetConverter:to-charset:
*
* The character encoding to convert to.
*
* Since: 2.24
*/
g_object_class_install_property (gobject_class,
PROP_TO_CHARSET,
g_param_spec_string ("to-charset",
@ -160,6 +167,14 @@ g_charset_converter_class_init (GCharsetConverterClass *klass)
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GCharsetConverter:from-charset:
*
* The character encoding to convert from.
*
* Since: 2.24
*/
g_object_class_install_property (gobject_class,
PROP_FROM_CHARSET,
g_param_spec_string ("from-charset",
@ -168,6 +183,14 @@ g_charset_converter_class_init (GCharsetConverterClass *klass)
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GCharsetConverter:use-fallback:
*
* Use fallback (of form `\<hexval>`) for invalid bytes.
*
* Since: 2.24
*/
g_object_class_install_property (gobject_class,
PROP_USE_FALLBACK,
g_param_spec_boolean ("use-fallback",

5
gio/gconverterinputstream.c
View File

@ -113,6 +113,11 @@ g_converter_input_stream_class_init (GConverterInputStreamClass *klass)
istream_class = G_INPUT_STREAM_CLASS (klass);
istream_class->read_fn = g_converter_input_stream_read;
/**
* GConverterInputStream:converter:
*
* The converter object.
*/
g_object_class_install_property (object_class,
PROP_CONVERTER,
g_param_spec_object ("converter",

5
gio/gconverteroutputstream.c
View File

@ -129,6 +129,11 @@ g_converter_output_stream_class_init (GConverterOutputStreamClass *klass)
istream_class->write_fn = g_converter_output_stream_write;
istream_class->flush = g_converter_output_stream_flush;
/**
* GConverterOutputStream:converter:
*
* The converter object.
*/
g_object_class_install_property (object_class,
PROP_CONVERTER,
g_param_spec_object ("converter",

14
gio/gemblem.c
View File

@ -134,6 +134,13 @@ g_emblem_class_init (GEmblemClass *klass)
gobject_class->set_property = g_emblem_set_property;
gobject_class->get_property = g_emblem_get_property;
/**
* GEmblem:origin:
*
* The origin the emblem is derived from.
*
* Since: 2.18
*/
g_object_class_install_property (gobject_class,
PROP_ORIGIN,
g_param_spec_enum ("origin",
@ -143,6 +150,13 @@ g_emblem_class_init (GEmblemClass *klass)
G_EMBLEM_ORIGIN_UNKNOWN,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GEmblem:icon:
*
* The actual icon of the emblem.
*
* Since: 2.18
*/
g_object_class_install_property (gobject_class,
PROP_ICON,
g_param_spec_object ("icon",

7
gio/gemblemedicon.c
View File

@ -123,6 +123,13 @@ g_emblemed_icon_class_init (GEmblemedIconClass *klass)
gobject_class->set_property = g_emblemed_icon_set_property;
gobject_class->get_property = g_emblemed_icon_get_property;
/**
* GEmblemedIcon:gicon:
*
* The [iface@Gio.Icon] to attach emblems to.
*
* Since: 2.18
*/
properties[PROP_GICON] =
g_param_spec_object ("gicon",
P_("The base GIcon"),

5
gio/gfileenumerator.c
View File

@ -157,6 +157,11 @@ g_file_enumerator_class_init (GFileEnumeratorClass *klass)
klass->close_async = g_file_enumerator_real_close_async;
klass->close_finish = g_file_enumerator_real_close_finish;
/**
* GFileEnumerator:container:
*
* The container that is being enumerated.
*/
g_object_class_install_property
(gobject_class, PROP_CONTAINER,
g_param_spec_object ("container", P_("Container"),

10
gio/gfilemonitor.c
View File

@ -188,6 +188,11 @@ g_file_monitor_class_init (GFileMonitorClass *klass)
G_TYPE_FROM_CLASS (klass),
_g_cclosure_marshal_VOID__OBJECT_OBJECT_ENUMv);
/**
* GFileMonitor:rate-limit:
*
* The limit of the monitor to watch for changes, in milliseconds.
*/
g_object_class_install_property (object_class, PROP_RATE_LIMIT,
g_param_spec_int ("rate-limit",
P_("Rate limit"),
@ -195,6 +200,11 @@ g_file_monitor_class_init (GFileMonitorClass *klass)
0, G_MAXINT, DEFAULT_RATE_LIMIT_MSECS, G_PARAM_READWRITE |
G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS));
/**
* GFileMonitor:cancelled:
*
* Whether the monitor has been cancelled.
*/
g_object_class_install_property (object_class, PROP_CANCELLED,
g_param_spec_boolean ("cancelled",
P_("Cancelled"),

10
gio/gfilterinputstream.c
View File

@ -89,6 +89,11 @@ g_filter_input_stream_class_init (GFilterInputStreamClass *klass)
istream_class->skip = g_filter_input_stream_skip;
istream_class->close_fn = g_filter_input_stream_close;
/**
* GFilterInputStream:base-stream:
*
* The underlying base stream on which the I/O ops will be done.
*/
g_object_class_install_property (object_class,
PROP_BASE_STREAM,
g_param_spec_object ("base-stream",
@ -98,6 +103,11 @@ g_filter_input_stream_class_init (GFilterInputStreamClass *klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
/**
* GFilterInputStream:close-base-stream:
*
* Whether the base stream should be closed when the filter stream is closed.
*/
g_object_class_install_property (object_class,
PROP_CLOSE_BASE,
g_param_spec_boolean ("close-base-stream",

10
gio/gfilteroutputstream.c
View File

@ -88,6 +88,11 @@ g_filter_output_stream_class_init (GFilterOutputStreamClass *klass)
ostream_class->flush = g_filter_output_stream_flush;
ostream_class->close_fn = g_filter_output_stream_close;
/**
* GFilterOutputStream:close-base-stream:
*
* The underlying base stream on which the I/O ops will be done.
*/
g_object_class_install_property (object_class,
PROP_BASE_STREAM,
g_param_spec_object ("base-stream",
@ -97,6 +102,11 @@ g_filter_output_stream_class_init (GFilterOutputStreamClass *klass)
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
/**
* GFilterOutputStream:close-base-stream:
*
* Whether the base stream should be closed when the filter stream is closed.
*/
g_object_class_install_property (object_class,
PROP_CLOSE_BASE,
g_param_spec_boolean ("close-base-stream",

14
gio/ginetaddress.c
View File

@ -185,6 +185,13 @@ g_inet_address_class_init (GInetAddressClass *klass)
gobject_class->set_property = g_inet_address_set_property;
gobject_class->get_property = g_inet_address_get_property;
/**
* GInetAddress:family:
*
* The address family (IPv4 or IPv6).
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_FAMILY,
g_param_spec_enum ("family",
P_("Address family"),
@ -195,6 +202,13 @@ g_inet_address_class_init (GInetAddressClass *klass)
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GInetAddress:bytes:
*
* The raw address data.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_BYTES,
g_param_spec_pointer ("bytes",
P_("Bytes"),

23
gio/ginetaddressmask.c
View File

@ -135,6 +135,13 @@ g_inet_address_mask_class_init (GInetAddressMaskClass *klass)
gobject_class->get_property = g_inet_address_mask_get_property;
gobject_class->dispose = g_inet_address_mask_dispose;
/**
* GInetAddressMask:family:
*
* The address family (IPv4 or IPv6).
*
* Since: 2.32
*/
g_object_class_install_property (gobject_class, PROP_FAMILY,
g_param_spec_enum ("family",
P_("Address family"),
@ -143,6 +150,14 @@ g_inet_address_mask_class_init (GInetAddressMaskClass *klass)
G_SOCKET_FAMILY_INVALID,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
/**
* GInetAddressMask:address:
*
* The base address.
*
* Since: 2.32
*/
g_object_class_install_property (gobject_class, PROP_ADDRESS,
g_param_spec_object ("address",
P_("Address"),
@ -150,6 +165,14 @@ g_inet_address_mask_class_init (GInetAddressMaskClass *klass)
G_TYPE_INET_ADDRESS,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GInetAddressMask:length:
*
* The prefix length, in bytes.
*
* Since: 2.32
*/
g_object_class_install_property (gobject_class, PROP_LENGTH,
g_param_spec_uint ("length",
P_("Length"),

16
gio/ginetsocketaddress.c
View File

@ -247,6 +247,13 @@ g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
gsocketaddress_class->to_native = g_inet_socket_address_to_native;
gsocketaddress_class->get_native_size = g_inet_socket_address_get_native_size;
/**
* GInetSocketAddress:address:
*
* The address.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_ADDRESS,
g_param_spec_object ("address",
P_("Address"),
@ -256,6 +263,13 @@ g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GInetSocketAddress:port:
*
* The port.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_PORT,
g_param_spec_uint ("port",
P_("Port"),
@ -286,7 +300,7 @@ g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
G_PARAM_STATIC_STRINGS));
/**
* GInetSocketAddress:scope_id:
* GInetSocketAddress:scope-id:
*
* The `sin6_scope_id` field, for IPv6 addresses.
*

22
gio/giostream.c
View File

@ -171,6 +171,13 @@ g_io_stream_class_init (GIOStreamClass *klass)
klass->close_async = g_io_stream_real_close_async;
klass->close_finish = g_io_stream_real_close_finish;
/**
* GIOStream:closed:
*
* Whether the stream is closed.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_CLOSED,
g_param_spec_boolean ("closed",
P_("Closed"),
@ -178,12 +185,27 @@ g_io_stream_class_init (GIOStreamClass *klass)
FALSE,
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GIOStream:input-stream:
*
* The [class@Gio.InputStream] to read from.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_INPUT_STREAM,
g_param_spec_object ("input-stream",
P_("Input stream"),
P_("The GInputStream to read from"),
G_TYPE_INPUT_STREAM,
G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
/**
* GIOStream:output-stream:
*
* The [class@Gio.OutputStream] to write to.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_OUTPUT_STREAM,
g_param_spec_object ("output-stream",
P_("Output stream"),

22
gio/gnetworkaddress.c
View File

@ -116,6 +116,13 @@ g_network_address_class_init (GNetworkAddressClass *klass)
gobject_class->get_property = g_network_address_get_property;
gobject_class->finalize = g_network_address_finalize;
/**
* GNetworkAddress:hostname:
*
* Hostname to resolve.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_HOSTNAME,
g_param_spec_string ("hostname",
P_("Hostname"),
@ -124,6 +131,14 @@ g_network_address_class_init (GNetworkAddressClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GNetworkAddress:port:
*
* Network port.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_PORT,
g_param_spec_uint ("port",
P_("Port"),
@ -133,6 +148,13 @@ g_network_address_class_init (GNetworkAddressClass *klass)
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GNetworkAddress:scheme:
*
* URI scheme.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_SCHEME,
g_param_spec_string ("scheme",
P_("Scheme"),

31
gio/gnetworkservice.c
View File

@ -114,6 +114,13 @@ g_network_service_class_init (GNetworkServiceClass *klass)
gobject_class->get_property = g_network_service_get_property;
gobject_class->finalize = g_network_service_finalize;
/**
* GNetworkService:service:
*
* Service name, for example `ldap`.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_SERVICE,
g_param_spec_string ("service",
P_("Service"),
@ -122,6 +129,14 @@ g_network_service_class_init (GNetworkServiceClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GNetworkService:protocol:
*
* Network protocol, for example `tcp`.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_PROTOCOL,
g_param_spec_string ("protocol",
P_("Protocol"),
@ -130,6 +145,14 @@ g_network_service_class_init (GNetworkServiceClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GNetworkService:domain:
*
* Network domain, for example `example.com`.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_DOMAIN,
g_param_spec_string ("domain",
P_("Domain"),
@ -138,6 +161,14 @@ g_network_service_class_init (GNetworkServiceClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GNetworkService:scheme:
*
* Network scheme (default is to use service).
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_DOMAIN,
g_param_spec_string ("scheme",
P_("Scheme"),

35
gio/gproxyaddress.c
View File

@ -186,6 +186,13 @@ g_proxy_address_class_init (GProxyAddressClass *klass)
gobject_class->set_property = g_proxy_address_set_property;
gobject_class->get_property = g_proxy_address_get_property;
/**
* GProxyAddress:protocol:
*
* The proxy protocol.
*
* Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_PROTOCOL,
g_param_spec_string ("protocol",
@ -196,6 +203,13 @@ g_proxy_address_class_init (GProxyAddressClass *klass)
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GProxyAddress:username:
*
* The proxy username.
*
* Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_USERNAME,
g_param_spec_string ("username",
@ -206,6 +220,13 @@ g_proxy_address_class_init (GProxyAddressClass *klass)
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GProxyAddress:password:
*
* The proxy password.
*
* Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_PASSWORD,
g_param_spec_string ("password",
@ -234,6 +255,13 @@ g_proxy_address_class_init (GProxyAddressClass *klass)
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GProxyAddress:destination-hostname:
*
* The proxy destination hostname.
*
* Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_DESTINATION_HOSTNAME,
g_param_spec_string ("destination-hostname",
@ -244,6 +272,13 @@ g_proxy_address_class_init (GProxyAddressClass *klass)
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GProxyAddress:destination-port:
*
* The proxy destination port.
*
* Since: 2.26
*/
g_object_class_install_property (gobject_class,
PROP_DESTINATION_PORT,
g_param_spec_uint ("destination-port",

10
gio/gproxyaddressenumerator.c
View File

@ -750,6 +750,11 @@ g_proxy_address_enumerator_class_init (GProxyAddressEnumeratorClass *proxy_enume
enumerator_class->next_async = g_proxy_address_enumerator_next_async;
enumerator_class->next_finish = g_proxy_address_enumerator_next_finish;
/**
* GProxyAddressEnumerator:uri:
*
* The destination URI. Use `none://` for a generic socket.
*/
g_object_class_install_property (object_class,
PROP_URI,
g_param_spec_string ("uri",
@ -778,6 +783,11 @@ g_proxy_address_enumerator_class_init (GProxyAddressEnumeratorClass *proxy_enume
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GProxyAddressEnumerator:connectable:
*
* The connectable being enumerated.
*/
g_object_class_install_property (object_class,
PROP_CONNECTABLE,
g_param_spec_object ("connectable",

4
gio/gsimpleiostream.c
View File

@ -159,6 +159,8 @@ g_simple_io_stream_class_init (GSimpleIOStreamClass *class)
/**
* GSimpleIOStream:input-stream:
*
* The [class@Gio.InputStream] to read from.
*
* Since: 2.44
*/
g_object_class_install_property (gobject_class, PROP_INPUT_STREAM,
@ -173,6 +175,8 @@ g_simple_io_stream_class_init (GSimpleIOStreamClass *class)
/**
* GSimpleIOStream:output-stream:
*
* The [class@Gio.OutputStream] to write to.
*
* Since: 2.44
*/
g_object_class_install_property (gobject_class, PROP_OUTPUT_STREAM,

63
gio/gsocket.c
View File

@ -952,6 +952,13 @@ g_socket_class_init (GSocketClass *klass)
gobject_class->set_property = g_socket_set_property;
gobject_class->get_property = g_socket_get_property;
/**
* GSocket:family:
*
* The socket’s address family.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_FAMILY,
g_param_spec_enum ("family",
P_("Socket family"),
@ -962,6 +969,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:type:
*
* The socket’s type.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_TYPE,
g_param_spec_enum ("type",
P_("Socket type"),
@ -972,6 +986,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:protocol:
*
* The ID of the protocol to use, or `-1` for unknown.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_PROTOCOL,
g_param_spec_enum ("protocol",
P_("Socket protocol"),
@ -982,6 +1003,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:fd:
*
* The socket’s file descriptor.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_FD,
g_param_spec_int ("fd",
P_("File descriptor"),
@ -993,6 +1021,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:blocking:
*
* Whether I/O on this socket is blocking.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_BLOCKING,
g_param_spec_boolean ("blocking",
P_("blocking"),
@ -1001,6 +1036,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:listen-backlog:
*
* The number of outstanding connections in the listen queue.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
g_param_spec_int ("listen-backlog",
P_("Listen backlog"),
@ -1011,6 +1053,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:keepalive:
*
* Whether to keep the connection alive by sending periodic pings.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_KEEPALIVE,
g_param_spec_boolean ("keepalive",
P_("Keep connection alive"),
@ -1019,6 +1068,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:local-address:
*
* The local address the socket is bound to.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
g_param_spec_object ("local-address",
P_("Local address"),
@ -1027,6 +1083,13 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
/**
* GSocket:remote-address:
*
* The remote address the socket is connected to.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_REMOTE_ADDRESS,
g_param_spec_object ("remote-address",
P_("Remote address"),

7
gio/gsocketaddress.c
View File

@ -109,6 +109,13 @@ g_socket_address_class_init (GSocketAddressClass *klass)
gobject_class->get_property = g_socket_address_get_property;
/**
* GSocketAddress:family:
*
* The family of the socket address.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_FAMILY,
g_param_spec_enum ("family",
P_("Address family"),

49
gio/gsocketclient.c
View File

@ -866,6 +866,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_TYPE_FROM_CLASS (class),
_g_cclosure_marshal_VOID__ENUM_OBJECT_OBJECTv);
/**
* GSocketClient:family:
*
* The address family to use for socket construction.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_FAMILY,
g_param_spec_enum ("family",
P_("Socket family"),
@ -876,6 +883,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocketClient:type:
*
* The type to use for socket construction.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_TYPE,
g_param_spec_enum ("type",
P_("Socket type"),
@ -886,6 +900,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocketClient:protocol:
*
* The protocol to use for socket construction, or `0` for default.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_PROTOCOL,
g_param_spec_enum ("protocol",
P_("Socket protocol"),
@ -896,6 +917,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocketClient:local-address:
*
* The local address constructed sockets will be bound to.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS,
g_param_spec_object ("local-address",
P_("Local address"),
@ -905,6 +933,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocketClient:timeout:
*
* The I/O timeout for sockets, in seconds, or `0` for none.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_TIMEOUT,
g_param_spec_uint ("timeout",
P_("Socket timeout"),
@ -914,6 +949,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocketClient:enable-proxy:
*
* Enable proxy support.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_ENABLE_PROXY,
g_param_spec_boolean ("enable-proxy",
P_("Enable proxy"),
@ -923,6 +965,13 @@ g_socket_client_class_init (GSocketClientClass *class)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GSocketClient:tls:
*
* Whether to create TLS connections.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_TLS,
g_param_spec_boolean ("tls",
P_("TLS"),

7
gio/gsocketconnection.c
View File

@ -445,6 +445,13 @@ g_socket_connection_class_init (GSocketConnectionClass *klass)
stream_class->close_async = g_socket_connection_close_async;
stream_class->close_finish = g_socket_connection_close_finish;
/**
* GSocketConnection:socket:
*
* The underlying [class@Gio.Socket].
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class,
PROP_SOCKET,
g_param_spec_object ("socket",

8
gio/gsocketlistener.c
View File

@ -154,6 +154,14 @@ g_socket_listener_class_init (GSocketListenerClass *klass)
gobject_class->finalize = g_socket_listener_finalize;
gobject_class->set_property = g_socket_listener_set_property;
gobject_class->get_property = g_socket_listener_get_property;
/**
* GSocketListener:listen-backlog:
*
* The number of outstanding connections in the listen queue.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
g_param_spec_int ("listen-backlog",
P_("Listen backlog"),

15
gio/gsubprocess.c
View File

@ -496,10 +496,25 @@ g_subprocess_class_init (GSubprocessClass *class)
gobject_class->finalize = g_subprocess_finalize;
gobject_class->set_property = g_subprocess_set_property;
/**
* GSubprocess:flags:
*
* Subprocess flags.
*
* Since: 2.40
*/
g_object_class_install_property (gobject_class, PROP_FLAGS,
g_param_spec_flags ("flags", P_("Flags"), P_("Subprocess flags"),
G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |
G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
/**
* GSubprocess:argv:
*
* Argument vector.
*
* Since: 2.40
*/
g_object_class_install_property (gobject_class, PROP_ARGV,
g_param_spec_boxed ("argv", P_("Arguments"), P_("Argument vector"),
G_TYPE_STRV, G_PARAM_WRITABLE |

7
gio/gsubprocesslauncher.c
View File

@ -176,6 +176,13 @@ g_subprocess_launcher_class_init (GSubprocessLauncherClass *class)
gobject_class->set_property = g_subprocess_launcher_set_property;
gobject_class->dispose = g_subprocess_launcher_dispose;
/**
* GSubprocessLauncher:flags:
*
* [flags@Gio.SubprocessFlags] for launched processes.
*
* Since: 2.40
*/
g_object_class_install_property (gobject_class, 1,
g_param_spec_flags ("flags", "Flags", "GSubprocessFlags for launched processes",
G_TYPE_SUBPROCESS_FLAGS, 0, G_PARAM_WRITABLE |

7
gio/gtcpconnection.c
View File

@ -128,6 +128,13 @@ g_tcp_connection_class_init (GTcpConnectionClass *class)
stream_class->close_fn = g_tcp_connection_close;
stream_class->close_async = g_tcp_connection_close_async;
/**
* GTcpConnection:graceful-disconnect:
*
* Whether [method@Gio.IOStream.close] does a graceful disconnect.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_GRACEFUL_DISCONNECT,
g_param_spec_boolean ("graceful-disconnect",
P_("Graceful Disconnect"),

7
gio/gtcpwrapperconnection.c
View File

@ -131,6 +131,13 @@ g_tcp_wrapper_connection_class_init (GTcpWrapperConnectionClass *klass)
stream_class->get_input_stream = g_tcp_wrapper_connection_get_input_stream;
stream_class->get_output_stream = g_tcp_wrapper_connection_get_output_stream;
/**
* GTcpWrapperConnection:base-io-stream:
*
* The wrapped [class@Gio.IOStream].
*
* Since: 2.28
*/
g_object_class_install_property (gobject_class,
PROP_BASE_IO_STREAM,
g_param_spec_object ("base-io-stream",

7
gio/gthreadedsocketservice.c
View File

@ -247,6 +247,13 @@ g_threaded_socket_service_class_init (GThreadedSocketServiceClass *class)
G_TYPE_FROM_CLASS (class),
_g_cclosure_marshal_BOOLEAN__OBJECT_OBJECTv);
/**
* GThreadedSocketService:max-threads:
*
* The maximum number of threads handling clients for this service.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_MAX_THREADS,
g_param_spec_int ("max-threads",
P_("Max threads"),

21
gio/gtlspassword.c
View File

@ -187,6 +187,13 @@ g_tls_password_class_init (GTlsPasswordClass *klass)
gobject_class->set_property = g_tls_password_set_property;
gobject_class->finalize = g_tls_password_finalize;
/**
* GTlsPassword:flags:
*
* Flags about the password.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class, PROP_FLAGS,
g_param_spec_flags ("flags",
P_("Flags"),
@ -196,6 +203,13 @@ g_tls_password_class_init (GTlsPasswordClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GTlsPassword:description:
*
* Description of what the password is for.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class, PROP_DESCRIPTION,
g_param_spec_string ("description",
P_("Description"),
@ -204,6 +218,13 @@ g_tls_password_class_init (GTlsPasswordClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
* GTlsPassword:warning:
*
* Warning about the password.
*
* Since: 2.30
*/
g_object_class_install_property (gobject_class, PROP_WARNING,
g_param_spec_string ("warning",
P_("Warning"),

7
gio/gunixfdmessage.c
View File

@ -213,6 +213,13 @@ g_unix_fd_message_class_init (GUnixFDMessageClass *class)
object_class->set_property = g_unix_fd_message_set_property;
object_class->get_property = g_unix_fd_message_get_property;
/**
* GUnixFDMessage:fd-list:
*
* The [class@Gio.UnixFDList] object to send with the message.
*
* Since: 2.22
*/
g_object_class_install_property (object_class, 1,
g_param_spec_object ("fd-list", "file descriptor list",
"The GUnixFDList object to send with the message",

24
gio/gunixsocketaddress.c
View File

@ -267,6 +267,13 @@ g_unix_socket_address_class_init (GUnixSocketAddressClass *klass)
gsocketaddress_class->to_native = g_unix_socket_address_to_native;
gsocketaddress_class->get_native_size = g_unix_socket_address_get_native_size;
/**
* GUnixSocketAddress:path:
*
* Unix socket path.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class,
PROP_PATH,
g_param_spec_string ("path",
@ -276,6 +283,14 @@ g_unix_socket_address_class_init (GUnixSocketAddressClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GUnixSocketAddress:path-as-array:
*
* Unix socket path, as a byte array.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_PATH_AS_ARRAY,
g_param_spec_boxed ("path-as-array",
P_("Path array"),
@ -284,6 +299,7 @@ g_unix_socket_address_class_init (GUnixSocketAddressClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GUnixSocketAddress:abstract:
*
@ -301,6 +317,14 @@ g_unix_socket_address_class_init (GUnixSocketAddressClass *klass)
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GUnixSocketAddress:address-type:
*
* The type of Unix socket address.
*
* Since: 2.22
*/
g_object_class_install_property (gobject_class, PROP_ADDRESS_TYPE,
g_param_spec_enum ("address-type",
P_("Address type"),

16
gio/gzlibcompressor.c
View File

@ -221,6 +221,13 @@ g_zlib_compressor_class_init (GZlibCompressorClass *klass)
gobject_class->get_property = g_zlib_compressor_get_property;
gobject_class->set_property = g_zlib_compressor_set_property;
/**
* GZlibCompressor:format:
*
* The format of the compressed data.
*
* Since: 2.24
*/
g_object_class_install_property (gobject_class,
PROP_FORMAT,
g_param_spec_enum ("format",
@ -230,6 +237,15 @@ g_zlib_compressor_class_init (GZlibCompressorClass *klass)
G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
/**
* GZlibCompressor:level:
*
* The level of compression from `0` (no compression) to `9` (most
* compression). `-1` for the default level.
*
* Since: 2.24
*/
g_object_class_install_property (gobject_class,
PROP_LEVEL,
g_param_spec_int ("level",

7
gio/gzlibdecompressor.c
View File

@ -215,6 +215,13 @@ g_zlib_decompressor_class_init (GZlibDecompressorClass *klass)
gobject_class->get_property = g_zlib_decompressor_get_property;
gobject_class->set_property = g_zlib_decompressor_set_property;
/**
* GZlibDecompressor:format:
*
* The format of the compressed data.
*
* Since: 2.24
*/
g_object_class_install_property (gobject_class,
PROP_FORMAT,
g_param_spec_enum ("format",