diff --git a/src/libnm-client-impl/nm-client.c b/src/libnm-client-impl/nm-client.c index 28d8d59c20..871c5466bf 100644 --- a/src/libnm-client-impl/nm-client.c +++ b/src/libnm-client-impl/nm-client.c @@ -5396,6 +5396,8 @@ nm_client_add_and_activate_connection2(NMClient *client, * * Returns: (transfer full): the new #NMActiveConnection on success, %NULL on * failure, in which case @error will be set. + * + * Since: 1.16 **/ NMActiveConnection * nm_client_add_and_activate_connection2_finish(NMClient *client, diff --git a/src/libnm-client-impl/nm-device-tun.c b/src/libnm-client-impl/nm-device-tun.c index 353b4bdc0c..2e75c860e1 100644 --- a/src/libnm-client-impl/nm-device-tun.c +++ b/src/libnm-client-impl/nm-device-tun.c @@ -124,7 +124,7 @@ nm_device_tun_get_group(NMDeviceTun *device) } /** - * nm_device_tun_get_pi: + * nm_device_tun_get_no_pi: * @device: a #NMDeviceTun * * Returns whether the #NMDeviceTun has the IFF_NO_PI flag. diff --git a/src/libnm-client-impl/nm-remote-connection.c b/src/libnm-client-impl/nm-remote-connection.c index 23dfc1dac3..b10d3d55fe 100644 --- a/src/libnm-client-impl/nm-remote-connection.c +++ b/src/libnm-client-impl/nm-remote-connection.c @@ -125,6 +125,8 @@ nm_remote_connection_update2(NMRemoteConnection *connection, * * Returns: (transfer full): on success, a #GVariant of type "a{sv}" with the result. On failure, * %NULL. + * + * Since: 1.12 **/ GVariant * nm_remote_connection_update2_finish(NMRemoteConnection *connection, diff --git a/src/libnm-client-impl/nm-vpn-service-plugin.c b/src/libnm-client-impl/nm-vpn-service-plugin.c index 3493d1db10..d26a4ff59f 100644 --- a/src/libnm-client-impl/nm-vpn-service-plugin.c +++ b/src/libnm-client-impl/nm-vpn-service-plugin.c @@ -136,6 +136,11 @@ nm_vpn_service_plugin_set_state(NMVpnServicePlugin *plugin, NMVpnServiceState st } } +/** + * nm_vpn_service_plugin_set_login_banner: + * + * Since: 1.2 + */ void nm_vpn_service_plugin_set_login_banner(NMVpnServicePlugin *plugin, const char *banner) { @@ -160,6 +165,11 @@ _emit_failure(NMVpnServicePlugin *plugin, NMVpnPluginFailure reason) nmdbus_vpn_plugin_emit_failure(priv->dbus_vpn_service_plugin, reason); } +/** + * nm_vpn_service_plugin_failure: + * + * Since: 1.2 + */ void nm_vpn_service_plugin_failure(NMVpnServicePlugin *plugin, NMVpnPluginFailure reason) { @@ -169,6 +179,11 @@ nm_vpn_service_plugin_failure(NMVpnServicePlugin *plugin, NMVpnPluginFailure rea nm_vpn_service_plugin_disconnect(plugin, NULL); } +/** + * nm_vpn_service_plugin_disconnect: + * + * Since: 1.2 + */ gboolean nm_vpn_service_plugin_disconnect(NMVpnServicePlugin *plugin, GError **err) { @@ -326,6 +341,11 @@ schedule_fail_stop(NMVpnServicePlugin *plugin, guint timeout_secs) priv->fail_stop_id = g_idle_add(fail_stop, plugin); } +/** + * nm_vpn_service_plugin_set_config: + * + * Since: 1.2 + */ void nm_vpn_service_plugin_set_config(NMVpnServicePlugin *plugin, GVariant *config) { @@ -364,6 +384,11 @@ nm_vpn_service_plugin_set_config(NMVpnServicePlugin *plugin, GVariant *config) nm_vpn_service_plugin_set_state(plugin, NM_VPN_SERVICE_STATE_STARTED); } +/** + * nm_vpn_service_plugin_set_ip4_config: + * + * Since: 1.2 + */ void nm_vpn_service_plugin_set_ip4_config(NMVpnServicePlugin *plugin, GVariant *ip4_config) { @@ -422,6 +447,11 @@ nm_vpn_service_plugin_set_ip4_config(NMVpnServicePlugin *plugin, GVariant *ip4_c nm_vpn_service_plugin_set_state(plugin, NM_VPN_SERVICE_STATE_STARTED); } +/** + * nm_vpn_service_plugin_set_ip6_config: + * + * Since: 1.2 + */ void nm_vpn_service_plugin_set_ip6_config(NMVpnServicePlugin *plugin, GVariant *ip6_config) { diff --git a/src/libnm-client-public/nm-checkpoint.h b/src/libnm-client-public/nm-checkpoint.h index 456d7f6bdc..c47ff39cd2 100644 --- a/src/libnm-client-public/nm-checkpoint.h +++ b/src/libnm-client-public/nm-checkpoint.h @@ -29,6 +29,8 @@ G_BEGIN_DECLS /** * NMCheckpoint: + * + * Since: 1.12 */ typedef struct _NMCheckpoint NMCheckpoint; typedef struct _NMCheckpointClass NMCheckpointClass; diff --git a/src/libnm-client-public/nm-client.h b/src/libnm-client-public/nm-client.h index 6307f11217..da5e509e0a 100644 --- a/src/libnm-client-public/nm-client.h +++ b/src/libnm-client-public/nm-client.h @@ -120,6 +120,11 @@ GQuark nm_client_error_quark(void); /* DNS stuff */ +/** + * NMDnsEntry: + * + * Since: 1.6 + */ typedef struct NMDnsEntry NMDnsEntry; NM_AVAILABLE_IN_1_6 diff --git a/src/libnm-client-public/nm-device-6lowpan.h b/src/libnm-client-public/nm-device-6lowpan.h index 80c2a2858b..0e45338881 100644 --- a/src/libnm-client-public/nm-device-6lowpan.h +++ b/src/libnm-client-public/nm-device-6lowpan.h @@ -29,6 +29,8 @@ G_BEGIN_DECLS /** * NMDevice6Lowpan: + * + * Since: 1.14 */ typedef struct _NMDevice6Lowpan NMDevice6Lowpan; typedef struct _NMDevice6LowpanClass NMDevice6LowpanClass; diff --git a/src/libnm-client-public/nm-device-dummy.h b/src/libnm-client-public/nm-device-dummy.h index 8b2f748577..0e6c6fe6c3 100644 --- a/src/libnm-client-public/nm-device-dummy.h +++ b/src/libnm-client-public/nm-device-dummy.h @@ -28,6 +28,8 @@ G_BEGIN_DECLS /** * NMDeviceDummy: + * + * Since: 1.8 */ typedef struct _NMDeviceDummy NMDeviceDummy; typedef struct _NMDeviceDummyClass NMDeviceDummyClass; diff --git a/src/libnm-client-public/nm-device-ip-tunnel.h b/src/libnm-client-public/nm-device-ip-tunnel.h index 4f55dc0bd4..4b9b9f5b1b 100644 --- a/src/libnm-client-public/nm-device-ip-tunnel.h +++ b/src/libnm-client-public/nm-device-ip-tunnel.h @@ -41,6 +41,8 @@ G_BEGIN_DECLS /** * NMDeviceIPTunnel: + * + * Since: 1.2 */ typedef struct _NMDeviceIPTunnel NMDeviceIPTunnel; typedef struct _NMDeviceIPTunnelClass NMDeviceIPTunnelClass; diff --git a/src/libnm-client-public/nm-device-macsec.h b/src/libnm-client-public/nm-device-macsec.h index b1ec363713..b2fb3429d4 100644 --- a/src/libnm-client-public/nm-device-macsec.h +++ b/src/libnm-client-public/nm-device-macsec.h @@ -41,6 +41,8 @@ G_BEGIN_DECLS /** * NMDeviceMacsec: + * + * Since: 1.6 */ typedef struct _NMDeviceMacsec NMDeviceMacsec; typedef struct _NMDeviceMacsecClass NMDeviceMacsecClass; diff --git a/src/libnm-client-public/nm-device-macvlan.h b/src/libnm-client-public/nm-device-macvlan.h index 9569933418..852920692e 100644 --- a/src/libnm-client-public/nm-device-macvlan.h +++ b/src/libnm-client-public/nm-device-macvlan.h @@ -32,6 +32,8 @@ G_BEGIN_DECLS /** * NMDeviceMacvlan: + * + * Since: 1.2 */ typedef struct _NMDeviceMacvlan NMDeviceMacvlan; typedef struct _NMDeviceMacvlanClass NMDeviceMacvlanClass; diff --git a/src/libnm-client-public/nm-device-ovs-bridge.h b/src/libnm-client-public/nm-device-ovs-bridge.h index 8c45405776..a6c9ff0bde 100644 --- a/src/libnm-client-public/nm-device-ovs-bridge.h +++ b/src/libnm-client-public/nm-device-ovs-bridge.h @@ -29,6 +29,8 @@ G_BEGIN_DECLS /** * NMDeviceOvsBridge: + * + * Since: 1.10 */ typedef struct _NMDeviceOvsBridge NMDeviceOvsBridge; typedef struct _NMDeviceOvsBridgeClass NMDeviceOvsBridgeClass; diff --git a/src/libnm-client-public/nm-device-ovs-interface.h b/src/libnm-client-public/nm-device-ovs-interface.h index 1ba7ac3a4c..eb74ee4834 100644 --- a/src/libnm-client-public/nm-device-ovs-interface.h +++ b/src/libnm-client-public/nm-device-ovs-interface.h @@ -28,6 +28,8 @@ G_BEGIN_DECLS /** * NMDeviceOvsInterface: + * + * Since: 1.10 */ typedef struct _NMDeviceOvsInterface NMDeviceOvsInterface; typedef struct _NMDeviceOvsInterfaceClass NMDeviceOvsInterfaceClass; diff --git a/src/libnm-client-public/nm-device-ovs-port.h b/src/libnm-client-public/nm-device-ovs-port.h index 7524cacb55..8014ed91ca 100644 --- a/src/libnm-client-public/nm-device-ovs-port.h +++ b/src/libnm-client-public/nm-device-ovs-port.h @@ -29,6 +29,8 @@ G_BEGIN_DECLS /** * NMDeviceOvsPort: + * + * Since: 1.10 */ typedef struct _NMDeviceOvsPort NMDeviceOvsPort; typedef struct _NMDeviceOvsPortClass NMDeviceOvsPortClass; diff --git a/src/libnm-client-public/nm-device-ppp.h b/src/libnm-client-public/nm-device-ppp.h index 4003f901c8..4d56cd89ca 100644 --- a/src/libnm-client-public/nm-device-ppp.h +++ b/src/libnm-client-public/nm-device-ppp.h @@ -23,10 +23,13 @@ G_BEGIN_DECLS /** * NMDevicePpp: + * + * Since: 1.10 */ typedef struct _NMDevicePpp NMDevicePpp; typedef struct _NMDevicePppClass NMDevicePppClass; +NM_AVAILABLE_IN_1_10 GType nm_device_ppp_get_type(void); G_END_DECLS diff --git a/src/libnm-client-public/nm-device-tun.h b/src/libnm-client-public/nm-device-tun.h index e1e7310d37..4269035887 100644 --- a/src/libnm-client-public/nm-device-tun.h +++ b/src/libnm-client-public/nm-device-tun.h @@ -33,6 +33,8 @@ G_BEGIN_DECLS /** * NMDeviceTun: + * + * Since: 1.2 */ typedef struct _NMDeviceTun NMDeviceTun; typedef struct _NMDeviceTunClass NMDeviceTunClass; diff --git a/src/libnm-client-public/nm-device-veth.h b/src/libnm-client-public/nm-device-veth.h index 8f61ae2052..66c1f101b8 100644 --- a/src/libnm-client-public/nm-device-veth.h +++ b/src/libnm-client-public/nm-device-veth.h @@ -27,6 +27,8 @@ G_BEGIN_DECLS /** * NMDeviceVeth: + * + * Since: 1.30 */ typedef struct _NMDeviceVeth NMDeviceVeth; typedef struct _NMDeviceVethClass NMDeviceVethClass; diff --git a/src/libnm-client-public/nm-device-vrf.h b/src/libnm-client-public/nm-device-vrf.h index fbc8b20224..82e0657dde 100644 --- a/src/libnm-client-public/nm-device-vrf.h +++ b/src/libnm-client-public/nm-device-vrf.h @@ -24,6 +24,8 @@ G_BEGIN_DECLS /** * NMDeviceVrf: + * + * Since: 1.24 */ typedef struct _NMDeviceVrf NMDeviceVrf; typedef struct _NMDeviceVrfClass NMDeviceVrfClass; diff --git a/src/libnm-client-public/nm-device-vxlan.h b/src/libnm-client-public/nm-device-vxlan.h index 7939539d61..f0d0820d44 100644 --- a/src/libnm-client-public/nm-device-vxlan.h +++ b/src/libnm-client-public/nm-device-vxlan.h @@ -45,6 +45,8 @@ G_BEGIN_DECLS /** * NMDeviceVxlan: + * + * Since: 1.2 */ typedef struct _NMDeviceVxlan NMDeviceVxlan; typedef struct _NMDeviceVxlanClass NMDeviceVxlanClass; diff --git a/src/libnm-client-public/nm-device-wireguard.h b/src/libnm-client-public/nm-device-wireguard.h index 756dfb4e46..fa1678785d 100644 --- a/src/libnm-client-public/nm-device-wireguard.h +++ b/src/libnm-client-public/nm-device-wireguard.h @@ -27,6 +27,8 @@ G_BEGIN_DECLS /** * NMDeviceWireGuard: + * + * Since: 1.14 */ typedef struct _NMDeviceWireGuard NMDeviceWireGuard; typedef struct _NMDeviceWireGuardClass NMDeviceWireGuardClass; diff --git a/src/libnm-client-public/nm-device-wpan.h b/src/libnm-client-public/nm-device-wpan.h index f6f5011c8e..d6805040a9 100644 --- a/src/libnm-client-public/nm-device-wpan.h +++ b/src/libnm-client-public/nm-device-wpan.h @@ -27,6 +27,8 @@ G_BEGIN_DECLS /** * NMDeviceWpan: + * + * Since: 1.14 */ typedef struct _NMDeviceWpan NMDeviceWpan; typedef struct _NMDeviceWpanClass NMDeviceWpanClass; diff --git a/src/libnm-client-public/nm-vpn-service-plugin.h b/src/libnm-client-public/nm-vpn-service-plugin.h index 5187d93d43..baf5b3a6d4 100644 --- a/src/libnm-client-public/nm-vpn-service-plugin.h +++ b/src/libnm-client-public/nm-vpn-service-plugin.h @@ -35,6 +35,8 @@ G_BEGIN_DECLS /** * NMVpnServicePlugin: + * + * Since: 1.2 */ typedef struct { NM_AVAILABLE_IN_1_2 diff --git a/src/libnm-client-public/nm-wifi-p2p-peer.h b/src/libnm-client-public/nm-wifi-p2p-peer.h index eff27bcbb9..dd8a109f33 100644 --- a/src/libnm-client-public/nm-wifi-p2p-peer.h +++ b/src/libnm-client-public/nm-wifi-p2p-peer.h @@ -37,6 +37,8 @@ G_BEGIN_DECLS /** * NMWifiP2PPeer: + * + * Since: 1.16 */ typedef struct _NMWifiP2PPeer NMWifiP2PPeer; typedef struct _NMWifiP2PPeerClass NMWifiP2PPeerClass; diff --git a/src/libnm-core-impl/nm-setting-6lowpan.c b/src/libnm-core-impl/nm-setting-6lowpan.c index 765af69b13..7b08575ecd 100644 --- a/src/libnm-core-impl/nm-setting-6lowpan.c +++ b/src/libnm-core-impl/nm-setting-6lowpan.c @@ -29,6 +29,8 @@ typedef struct { * NMSetting6Lowpan: * * 6LoWPAN Settings + * + * Since: 1.14 */ struct _NMSetting6Lowpan { NMSetting parent; diff --git a/src/libnm-core-impl/nm-setting-bridge.c b/src/libnm-core-impl/nm-setting-bridge.c index 39a3fb6017..8961114707 100644 --- a/src/libnm-core-impl/nm-setting-bridge.c +++ b/src/libnm-core-impl/nm-setting-bridge.c @@ -926,7 +926,7 @@ _nm_setting_bridge_get_vlans(NMSettingBridge *setting) * * Returns: the #NMSettingBridge:group-address property of the setting * - * Since 1.24 + * Since: 1.24 **/ const char * nm_setting_bridge_get_group_address(const NMSettingBridge *setting) @@ -942,7 +942,7 @@ nm_setting_bridge_get_group_address(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:vlan-protocol property of the setting * - * Since 1.24 + * Since: 1.24 **/ const char * nm_setting_bridge_get_vlan_protocol(const NMSettingBridge *setting) @@ -958,7 +958,7 @@ nm_setting_bridge_get_vlan_protocol(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:vlan-stats-enabled property of the setting * - * Since 1.24 + * Since: 1.24 **/ gboolean nm_setting_bridge_get_vlan_stats_enabled(const NMSettingBridge *setting) @@ -974,7 +974,7 @@ nm_setting_bridge_get_vlan_stats_enabled(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-router property of the setting * - * Since 1.24 + * Since: 1.24 **/ const char * nm_setting_bridge_get_multicast_router(const NMSettingBridge *setting) @@ -990,7 +990,7 @@ nm_setting_bridge_get_multicast_router(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-query-use-ifaddr property of the setting * - * Since 1.24 + * Since: 1.24 **/ gboolean nm_setting_bridge_get_multicast_query_use_ifaddr(const NMSettingBridge *setting) @@ -1006,7 +1006,7 @@ nm_setting_bridge_get_multicast_query_use_ifaddr(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-querier property of the setting * - * Since 1.24 + * Since: 1.24 **/ gboolean nm_setting_bridge_get_multicast_querier(const NMSettingBridge *setting) @@ -1022,7 +1022,7 @@ nm_setting_bridge_get_multicast_querier(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-hash-max property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint32 nm_setting_bridge_get_multicast_hash_max(const NMSettingBridge *setting) @@ -1038,7 +1038,7 @@ nm_setting_bridge_get_multicast_hash_max(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-last-member-count property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint32 nm_setting_bridge_get_multicast_last_member_count(const NMSettingBridge *setting) @@ -1054,7 +1054,7 @@ nm_setting_bridge_get_multicast_last_member_count(const NMSettingBridge *setting * * Returns: the #NMSettingBridge:multicast-last-member-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint64 nm_setting_bridge_get_multicast_last_member_interval(const NMSettingBridge *setting) @@ -1070,7 +1070,7 @@ nm_setting_bridge_get_multicast_last_member_interval(const NMSettingBridge *sett * * Returns: the #NMSettingBridge:multicast-membership-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint64 nm_setting_bridge_get_multicast_membership_interval(const NMSettingBridge *setting) @@ -1086,7 +1086,7 @@ nm_setting_bridge_get_multicast_membership_interval(const NMSettingBridge *setti * * Returns: the #NMSettingBridge:multicast-querier-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint64 nm_setting_bridge_get_multicast_querier_interval(const NMSettingBridge *setting) @@ -1102,7 +1102,7 @@ nm_setting_bridge_get_multicast_querier_interval(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-query-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint64 nm_setting_bridge_get_multicast_query_interval(const NMSettingBridge *setting) @@ -1118,7 +1118,7 @@ nm_setting_bridge_get_multicast_query_interval(const NMSettingBridge *setting) * * Returns: the #NMSettingBridge:multicast-query-response-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint64 nm_setting_bridge_get_multicast_query_response_interval(const NMSettingBridge *setting) @@ -1134,7 +1134,7 @@ nm_setting_bridge_get_multicast_query_response_interval(const NMSettingBridge *s * * Returns: the #NMSettingBridge:multicast-query-response-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint32 nm_setting_bridge_get_multicast_startup_query_count(const NMSettingBridge *setting) @@ -1150,7 +1150,7 @@ nm_setting_bridge_get_multicast_startup_query_count(const NMSettingBridge *setti * * Returns: the #NMSettingBridge:multicast-startup-query-interval property of the setting * - * Since 1.26 + * Since: 1.26 **/ guint64 nm_setting_bridge_get_multicast_startup_query_interval(const NMSettingBridge *setting) diff --git a/src/libnm-core-impl/nm-setting-ip-config.c b/src/libnm-core-impl/nm-setting-ip-config.c index ac1b8fdd5c..73f98ab166 100644 --- a/src/libnm-core-impl/nm-setting-ip-config.c +++ b/src/libnm-core-impl/nm-setting-ip-config.c @@ -266,6 +266,8 @@ nm_ip_address_unref(NMIPAddress *address) * * Returns: 0 if the two objects have the same values (according to their flags) * or a integer indicating the compare order. + * + * Since: 1.22 **/ int nm_ip_address_cmp_full(const NMIPAddress *a, const NMIPAddress *b, NMIPAddressCmpFlags cmp_flags) @@ -4343,6 +4345,8 @@ nm_setting_ip_config_get_num_dns_options(NMSettingIPConfig *setting) * a default configuration, while the former explicitly means "no-options". * * Returns: whether DNS options are initialized or left unset (the default). + * + * Since: 1.2 **/ gboolean nm_setting_ip_config_has_dns_options(NMSettingIPConfig *setting) diff --git a/src/libnm-core-impl/nm-setting-ip-tunnel.c b/src/libnm-core-impl/nm-setting-ip-tunnel.c index d42e97b9ae..bcbcc41182 100644 --- a/src/libnm-core-impl/nm-setting-ip-tunnel.c +++ b/src/libnm-core-impl/nm-setting-ip-tunnel.c @@ -286,7 +286,7 @@ nm_setting_ip_tunnel_get_mtu(NMSettingIPTunnel *setting) return NM_SETTING_IP_TUNNEL_GET_PRIVATE(setting)->mtu; } -/* +/** * nm_setting_ip_tunnel_get_flags: * @setting: the #NMSettingIPTunnel * diff --git a/src/libnm-core-impl/nm-setting-ip4-config.c b/src/libnm-core-impl/nm-setting-ip4-config.c index ff56834e1a..58ec836d44 100644 --- a/src/libnm-core-impl/nm-setting-ip4-config.c +++ b/src/libnm-core-impl/nm-setting-ip4-config.c @@ -898,7 +898,7 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass) * a global connection default gets consulted. * If still unspecified, the DHCP option is not sent to the server. * - * Since 1.28 + * Since: 1.28 */ /* ---ifcfg-rh--- * property: dhcp-vendor-class-identifier @@ -928,7 +928,7 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass) * falling back to "auto". Note that if "ipv4.method" is "disabled", then * link local addressing is always disabled too. The default is "default". * - * Since 1.40 + * Since: 1.40 */ /* ---ifcfg-rh--- * property: link-local diff --git a/src/libnm-core-impl/nm-setting-ovs-external-ids.c b/src/libnm-core-impl/nm-setting-ovs-external-ids.c index 6b8d5d37a6..f4e31f81ce 100644 --- a/src/libnm-core-impl/nm-setting-ovs-external-ids.c +++ b/src/libnm-core-impl/nm-setting-ovs-external-ids.c @@ -195,6 +195,8 @@ _nm_setting_ovs_external_ids_get_data(NMSettingOvsExternalIDs *self) * * Returns: (array length=out_len) (transfer none): a * %NULL-terminated array containing each key from the table. + * + * Since: 1.30 **/ const char *const * nm_setting_ovs_external_ids_get_data_keys(NMSettingOvsExternalIDs *setting, guint *out_len) diff --git a/src/libnm-core-impl/nm-setting-sriov.c b/src/libnm-core-impl/nm-setting-sriov.c index 30dd8f541b..b97f54ce36 100644 --- a/src/libnm-core-impl/nm-setting-sriov.c +++ b/src/libnm-core-impl/nm-setting-sriov.c @@ -649,7 +649,7 @@ nm_sriov_vf_get_vlan_qos(const NMSriovVF *vf, guint vlan_id) return vlan->qos; } -/* +/** * nm_sriov_vf_get_vlan_protocol: * @vf: the #NMSriovVF * @vlan_id: the VLAN id diff --git a/src/libnm-core-impl/nm-setting-user.c b/src/libnm-core-impl/nm-setting-user.c index 0e95d38bcf..70bdc62a9e 100644 --- a/src/libnm-core-impl/nm-setting-user.c +++ b/src/libnm-core-impl/nm-setting-user.c @@ -35,6 +35,8 @@ typedef struct { * NMSettingUser: * * General User Profile Settings + * + * Since: 1.8 */ struct _NMSettingUser { NMSetting parent; @@ -216,6 +218,8 @@ _create_data_hash(void) * * Returns: (array length=out_len) (transfer none): a * %NULL-terminated array containing each key from the table. + * + * Since: 1.8 **/ const char *const * nm_setting_user_get_keys(NMSettingUser *setting, guint *out_len) @@ -498,6 +502,8 @@ nm_setting_user_init(NMSettingUser *self) * Creates a new #NMSettingUser object with default values. * * Returns: the new empty #NMSettingUser object + * + * Since: 1.8 **/ NMSetting * nm_setting_user_new(void) diff --git a/src/libnm-core-impl/nm-setting-vpn.c b/src/libnm-core-impl/nm-setting-vpn.c index 42f75fa211..7e6f18dd67 100644 --- a/src/libnm-core-impl/nm-setting-vpn.c +++ b/src/libnm-core-impl/nm-setting-vpn.c @@ -147,6 +147,8 @@ nm_setting_vpn_get_user_name(NMSettingVpn *setting) * @setting: the #NMSettingVpn * * Returns: the #NMSettingVpn:persistent property of the setting + * + * Since: 1.42, 1.40.4 **/ gboolean nm_setting_vpn_get_persistent(NMSettingVpn *setting) diff --git a/src/libnm-core-impl/nm-setting-wireguard.c b/src/libnm-core-impl/nm-setting-wireguard.c index ad0f01d5c5..599ded3c42 100644 --- a/src/libnm-core-impl/nm-setting-wireguard.c +++ b/src/libnm-core-impl/nm-setting-wireguard.c @@ -1437,7 +1437,7 @@ _peers_clear(NMSettingWireGuardPrivate *priv) } /** - * nm_setting_wireguard_: + * nm_setting_wireguard_clear_peers: * @self: the #NMSettingWireGuard instance * * Returns: the number of cleared peers. diff --git a/src/libnm-core-impl/nm-setting-wireless-security.c b/src/libnm-core-impl/nm-setting-wireless-security.c index d9c5afb873..ebefd504d3 100644 --- a/src/libnm-core-impl/nm-setting-wireless-security.c +++ b/src/libnm-core-impl/nm-setting-wireless-security.c @@ -561,7 +561,7 @@ nm_setting_wireless_security_clear_groups(NMSettingWirelessSecurity *setting) _notify(setting, PROP_GROUP); } -/* +/** * nm_setting_wireless_security_get_pmf: * @setting: the #NMSettingWirelessSecurity * @@ -798,7 +798,7 @@ nm_setting_wireless_security_get_wps_method(NMSettingWirelessSecurity *setting) return NM_SETTING_WIRELESS_SECURITY_GET_PRIVATE(setting)->wps_method; } -/* +/** * nm_setting_wireless_security_get_fils: * @setting: the #NMSettingWirelessSecurity * diff --git a/src/libnm-core-impl/nm-setting-wpan.c b/src/libnm-core-impl/nm-setting-wpan.c index 9e25dd1656..4bb9e0dec0 100644 --- a/src/libnm-core-impl/nm-setting-wpan.c +++ b/src/libnm-core-impl/nm-setting-wpan.c @@ -53,6 +53,8 @@ typedef struct { * NMSettingWpan: * * IEEE 802.15.4 (WPAN) MAC Settings + * + * Since: 1.14 */ struct _NMSettingWpan { NMSetting parent; diff --git a/src/libnm-core-impl/nm-setting.c b/src/libnm-core-impl/nm-setting.c index 02a79756ab..b6f721371f 100644 --- a/src/libnm-core-impl/nm-setting.c +++ b/src/libnm-core-impl/nm-setting.c @@ -3861,7 +3861,7 @@ nm_setting_option_clear_by_name(NMSetting *setting, NMUtilsPredicateStr predicat * Returns: (transfer none): the #GVariant or %NULL if the option * is not set. * - * Since: 1.26. + * Since: 1.26 */ GVariant * nm_setting_option_get(NMSetting *setting, const char *opt_name) diff --git a/src/libnm-core-impl/nm-utils.c b/src/libnm-core-impl/nm-utils.c index 3c4cbc651e..0922b1ab85 100644 --- a/src/libnm-core-impl/nm-utils.c +++ b/src/libnm-core-impl/nm-utils.c @@ -4314,6 +4314,8 @@ nm_utils_is_valid_iface_name_utf8safe(const char *utf8safe_name) * * Before 1.20, this function did not accept %NULL as @name argument. If you * want to run against older versions of libnm, don't pass %NULL. + * + * Since: 1.6 */ gboolean nm_utils_is_valid_iface_name(const char *name, GError **error) @@ -5249,7 +5251,7 @@ next: return g_steal_pointer(&ht); } -/* +/** * nm_utils_format_variant_attributes: * @attributes: (element-type utf8 GVariant): a #GHashTable mapping attribute names to #GVariant values * @attr_separator: the attribute separator character @@ -5275,8 +5277,8 @@ nm_utils_format_variant_attributes(GHashTable *attributes, /*****************************************************************************/ -/* - * nm_utils_get_timestamp_msec(): +/** + * nm_utils_get_timestamp_msec: * * Gets current time in milliseconds of CLOCK_BOOTTIME. * @@ -5314,7 +5316,7 @@ nm_utils_get_timestamp_msec(void) * Returns: the version ID of the libnm version. That is, the %NM_VERSION * at runtime. * - * Since: 1.6.0 + * Since: 1.6 */ guint nm_utils_version(void) diff --git a/src/libnm-core-public/nm-dbus-interface.h b/src/libnm-core-public/nm-dbus-interface.h index 4557dde0fb..6e1a84a1dd 100644 --- a/src/libnm-core-public/nm-dbus-interface.h +++ b/src/libnm-core-public/nm-dbus-interface.h @@ -103,6 +103,8 @@ * The range 0x7000 - 0x7FFF of capabilities is guaranteed not to be * used by upstream NetworkManager. It could thus be used for downstream * extensions. + * + * Since: 1.6 */ typedef enum { NM_CAPABILITY_TEAM = 1, @@ -967,7 +969,7 @@ typedef enum { * * The flags for CheckpointCreate call * - * Since: 1.4 (gi flags generated since 1.12) + * Since: 1.12 (public since 1.4, g-ir since 1.12) */ typedef enum /*< flags >*/ { NM_CHECKPOINT_CREATE_FLAG_NONE = 0, diff --git a/src/libnm-core-public/nm-setting-connection.h b/src/libnm-core-public/nm-setting-connection.h index 4b6ce17c4a..94ea72cbe8 100644 --- a/src/libnm-core-public/nm-setting-connection.h +++ b/src/libnm-core-public/nm-setting-connection.h @@ -73,6 +73,8 @@ G_BEGIN_DECLS * * #NMSettingConnectionAutoconnectSlaves values indicate whether slave connections * should be activated when master is activated. + * + * Since: 1.2 */ typedef enum { NM_SETTING_CONNECTION_AUTOCONNECT_SLAVES_DEFAULT = -1, @@ -87,6 +89,8 @@ typedef enum { * @NM_SETTING_CONNECTION_LLDP_ENABLE_RX: enable reception of LLDP frames * * #NMSettingConnectionLldp values indicate whether LLDP should be enabled. + * + * Since: 1.2 */ typedef enum { NM_SETTING_CONNECTION_LLDP_DEFAULT = -1, diff --git a/src/libnm-core-public/nm-setting-ip-tunnel.h b/src/libnm-core-public/nm-setting-ip-tunnel.h index 3492009974..b634ceb7e3 100644 --- a/src/libnm-core-public/nm-setting-ip-tunnel.h +++ b/src/libnm-core-public/nm-setting-ip-tunnel.h @@ -43,7 +43,7 @@ G_BEGIN_DECLS typedef struct _NMSettingIPTunnelClass NMSettingIPTunnelClass; -/* +/** * NMIPTunnelFlags: * @NM_IP_TUNNEL_FLAG_NONE: no flag * @NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT: don't add encapsulation limit diff --git a/src/libnm-core-public/nm-setting-macvlan.h b/src/libnm-core-public/nm-setting-macvlan.h index 88ee81e727..25c413469b 100644 --- a/src/libnm-core-public/nm-setting-macvlan.h +++ b/src/libnm-core-public/nm-setting-macvlan.h @@ -42,6 +42,8 @@ typedef struct _NMSettingMacvlanClass NMSettingMacvlanClass; * @NM_SETTING_MACVLAN_MODE_PRIVATE: private mode * @NM_SETTING_MACVLAN_MODE_PASSTHRU: passthru mode * @NM_SETTING_MACVLAN_MODE_SOURCE: source mode + * + * Since: 1.2 **/ typedef enum { NM_SETTING_MACVLAN_MODE_UNKNOWN = 0, diff --git a/src/libnm-core-public/nm-setting-team.h b/src/libnm-core-public/nm-setting-team.h index 63df408011..2e16ee201b 100644 --- a/src/libnm-core-public/nm-setting-team.h +++ b/src/libnm-core-public/nm-setting-team.h @@ -25,6 +25,8 @@ G_BEGIN_DECLS * option 'validate_inactive' is enabled (set to true). * @NM_TEAM_LINK_WATCHER_ARP_PING_FLAG_SEND_ALWAYS: the arp_ping link watcher option * 'send_always' is enabled (set to true). + * + * Since: 1.12 */ typedef enum /*< flags >*/ { NM_TEAM_LINK_WATCHER_ARP_PING_FLAG_NONE = 0, /*< skip >*/ diff --git a/src/libnm-core-public/nm-setting-tun.h b/src/libnm-core-public/nm-setting-tun.h index 8f8084109c..3575c644fa 100644 --- a/src/libnm-core-public/nm-setting-tun.h +++ b/src/libnm-core-public/nm-setting-tun.h @@ -39,6 +39,8 @@ G_BEGIN_DECLS * @NM_SETTING_TUN_MODE_TAP: a TAP device * * #NMSettingTunMode values indicate the device type (TUN/TAP) + * + * Since: 1.2 */ typedef enum { NM_SETTING_TUN_MODE_UNKNOWN = 0, diff --git a/src/libnm-core-public/nm-setting-wireless-security.h b/src/libnm-core-public/nm-setting-wireless-security.h index e564204bb4..b9fea123b0 100644 --- a/src/libnm-core-public/nm-setting-wireless-security.h +++ b/src/libnm-core-public/nm-setting-wireless-security.h @@ -74,6 +74,8 @@ typedef enum { * @NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED: require PMF and fail if not available * * These flags indicate whether PMF must be enabled. + * + * Since: 1.10 **/ typedef enum { NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT = 0, diff --git a/src/libnm-core-public/nm-setting-wireless.h b/src/libnm-core-public/nm-setting-wireless.h index 1f94060cde..bb15811203 100644 --- a/src/libnm-core-public/nm-setting-wireless.h +++ b/src/libnm-core-public/nm-setting-wireless.h @@ -132,6 +132,8 @@ typedef enum /*< flags >*/ { * @NM_SETTING_WIRELESS_POWERSAVE_ENABLE: enable powersave * * These flags indicate whether wireless powersave must be enabled. + * + * Since: 1.2 **/ typedef enum { NM_SETTING_WIRELESS_POWERSAVE_DEFAULT = 0, diff --git a/src/libnm-core-public/nm-setting.h b/src/libnm-core-public/nm-setting.h index 5c5b621cda..ae898458a3 100644 --- a/src/libnm-core-public/nm-setting.h +++ b/src/libnm-core-public/nm-setting.h @@ -122,6 +122,8 @@ typedef enum { * @NM_SETTING_MAC_RANDOMIZATION_ALWAYS: a random MAC address is used. * * Controls if and how the MAC address of a device is randomzied. + * + * Since: 1.2 **/ typedef enum { NM_SETTING_MAC_RANDOMIZATION_DEFAULT = 0, diff --git a/src/libnmc-setting/settings-docs.h.in b/src/libnmc-setting/settings-docs.h.in index 1ed2f13419..934ddff96f 100644 --- a/src/libnmc-setting/settings-docs.h.in +++ b/src/libnmc-setting/settings-docs.h.in @@ -166,7 +166,7 @@ #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DHCP_REJECT_SERVERS N_("Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. \"192.168.122.0/24\"). This property is currently not implemented for DHCPv6.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME N_("If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the \"dhcp-hostname\" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DHCP_TIMEOUT N_("A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.") -#define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DHCP_VENDOR_CLASS_IDENTIFIER N_("The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server. Since 1.28") +#define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DHCP_VENDOR_CLASS_IDENTIFIER N_("The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DNS N_("Array of IP addresses of DNS servers.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DNS_OPTIONS N_("Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. The currently supported options are \"attempts\", \"debug\", \"edns0\", \"inet6\", \"ip6-bytestring\", \"ip6-dotint\", \"ndots\", \"no-check-names\", \"no-ip6-dotint\", \"no-reload\", \"no-tld-query\", \"rotate\", \"single-request\", \"single-request-reopen\", \"timeout\", \"trust-ad\", \"use-vc\". The \"trust-ad\" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have \"trust-ad\" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then \"edns0\" and \"trust-ad\" are automatically added.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_DNS_PRIORITY N_("DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the \"rotate\" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.") @@ -174,7 +174,7 @@ #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_GATEWAY N_("The gateway associated with this configuration. This is only meaningful if \"addresses\" is also set. Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if \"never-default\" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See \"ip4-auto-default-route\".") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS N_("When \"method\" is set to \"auto\" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the \"dns\" and \"dns-search\" properties, if any, are used.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES N_("When \"method\" is set to \"auto\" and this property to TRUE, automatically configured routes are ignored and only routes specified in the \"routes\" property, if any, are used.") -#define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_LINK_LOCAL N_("Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. When set to \"auto\", the value is dependent on \"ipv4.method\". When set to \"default\", it honors the global connection default, before falling back to \"auto\". Note that if \"ipv4.method\" is \"disabled\", then link local addressing is always disabled too. The default is \"default\". Since 1.40") +#define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_LINK_LOCAL N_("Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. When set to \"auto\", the value is dependent on \"ipv4.method\". When set to \"default\", it honors the global connection default, before falling back to \"auto\". Note that if \"ipv4.method\" is \"disabled\", then link local addressing is always disabled too. The default is \"default\".") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_MAY_FAIL N_("If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_METHOD N_("IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support \"disabled\", \"auto\", \"manual\", and \"link-local\". See the subclass-specific documentation for other values. In general, for the \"auto\" method, properties such as \"dns\" and \"routes\" specify information that is added on to the information returned from automatic configuration. The \"ignore-auto-routes\" and \"ignore-auto-dns\" properties modify this behavior. For methods that imply no upstream network, such as \"shared\" or \"link-local\", these properties must be empty. For IPv4 method \"shared\", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.") #define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_NEVER_DEFAULT N_("If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.") diff --git a/src/nmcli/generate-docs-nm-settings-nmcli.xml.in b/src/nmcli/generate-docs-nm-settings-nmcli.xml.in index 371081b0e0..5da5c979a8 100644 --- a/src/nmcli/generate-docs-nm-settings-nmcli.xml.in +++ b/src/nmcli/generate-docs-nm-settings-nmcli.xml.in @@ -699,9 +699,9 @@ + description="The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server." /> + description="Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default"." />