From 873550592cf49cc78e37a476e40c80b815c2e3ab Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Wed, 20 Feb 2013 14:45:09 -0600 Subject: [PATCH] libnm-util: add Since tags to new functions and properties --- libnm-util/nm-setting-bridge-port.c | 18 +++++++++++++++ libnm-util/nm-setting-bridge-port.h | 2 ++ libnm-util/nm-setting-bridge.c | 34 +++++++++++++++++++++++++++++ libnm-util/nm-setting-bridge.h | 2 ++ libnm-util/nm-setting-connection.c | 10 +++++++++ libnm-util/nm-setting-ip6-config.c | 4 ++++ libnm-util/nm-setting-wireless.h | 2 ++ libnm-util/nm-utils.c | 10 +++++++++ 8 files changed, 82 insertions(+) diff --git a/libnm-util/nm-setting-bridge-port.c b/libnm-util/nm-setting-bridge-port.c index d7f3dd59d..c1abf9c80 100644 --- a/libnm-util/nm-setting-bridge-port.c +++ b/libnm-util/nm-setting-bridge-port.c @@ -38,6 +38,8 @@ * * The #NMSettingBridgePort object is a #NMSetting subclass that describes * optional properties that apply to bridge ports. + * + * Since: 0.9.8 **/ /** @@ -46,6 +48,8 @@ * Registers an error quark for #NMSettingBridgePort if necessary. * * Returns: the error quark used for #NMSettingBridgePort errors. + * + * Since: 0.9.8 **/ GQuark nm_setting_bridge_port_error_quark (void) @@ -87,6 +91,8 @@ enum { * @setting: the #NMSettingBridgePort * * Returns: the #NMSettingBridgePort:priority property of the setting + * + * Since: 0.9.8 **/ guint16 nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting) @@ -101,6 +107,8 @@ nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting) * @setting: the #NMSettingBridgePort * * Returns: the #NMSettingBridgePort:path-cost property of the setting + * + * Since: 0.9.8 **/ guint16 nm_setting_bridge_port_get_path_cost (NMSettingBridgePort *setting) @@ -115,6 +123,8 @@ nm_setting_bridge_port_get_path_cost (NMSettingBridgePort *setting) * @setting: the #NMSettingBridgePort * * Returns: the #NMSettingBridgePort:hairpin-mode property of the setting + * + * Since: 0.9.8 **/ gboolean nm_setting_bridge_port_get_hairpin_mode (NMSettingBridgePort *setting) @@ -164,6 +174,8 @@ verify (NMSetting *setting, GSList *all_settings, GError **error) * Creates a new #NMSettingBridgePort object with default values. * * Returns: (transfer full): the new empty #NMSettingBridgePort object + * + * Since: 0.9.8 **/ NMSetting * nm_setting_bridge_port_new (void) @@ -239,6 +251,8 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class) * NMSettingBridgePort:priority: * * The Spanning Tree Protocol (STP) priority of this bridge port. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_PRIORITY, @@ -252,6 +266,8 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class) * NMSettingBridgePort:path-cost: * * The Spanning Tree Protocol (STP) port cost for destinations via this port. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_PATH_COST, @@ -267,6 +283,8 @@ nm_setting_bridge_port_class_init (NMSettingBridgePortClass *setting_class) * * Enables or disabled 'hairpin mode' for the port, which allows frames to * be sent back out through the port the frame was received on. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_HAIRPIN_MODE, diff --git a/libnm-util/nm-setting-bridge-port.h b/libnm-util/nm-setting-bridge-port.h index 5123f0a71..7848b75ff 100644 --- a/libnm-util/nm-setting-bridge-port.h +++ b/libnm-util/nm-setting-bridge-port.h @@ -43,6 +43,8 @@ G_BEGIN_DECLS * @NM_SETTING_BRIDGE_PORT_ERROR_INVALID_PROPERTY: the property was invalid * @NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY: the property was missing and * is required + * + * Since: 0.9.8 */ typedef enum { NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ diff --git a/libnm-util/nm-setting-bridge.c b/libnm-util/nm-setting-bridge.c index 3363ffd47..c6b3f2995 100644 --- a/libnm-util/nm-setting-bridge.c +++ b/libnm-util/nm-setting-bridge.c @@ -40,6 +40,8 @@ * * The #NMSettingBridge object is a #NMSetting subclass that describes properties * necessary for bridging connections. + * + * Since: 0.9.8 **/ /** @@ -48,6 +50,8 @@ * Registers an error quark for #NMSettingBridge if necessary. * * Returns: the error quark used for #NMSettingBridge errors. + * + * Since: 0.9.8 **/ GQuark nm_setting_bridge_error_quark (void) @@ -97,6 +101,8 @@ enum { * Creates a new #NMSettingBridge object with default values. * * Returns: (transfer full): the new empty #NMSettingBridge object + * + * Since: 0.9.8 **/ NMSetting * nm_setting_bridge_new (void) @@ -109,6 +115,8 @@ nm_setting_bridge_new (void) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:interface-name property of the setting + * + * Since: 0.9.8 **/ const char * nm_setting_bridge_get_interface_name (NMSettingBridge *setting) @@ -123,6 +131,8 @@ nm_setting_bridge_get_interface_name (NMSettingBridge *setting) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:stp property of the setting + * + * Since: 0.9.8 **/ gboolean nm_setting_bridge_get_stp (NMSettingBridge *setting) @@ -137,6 +147,8 @@ nm_setting_bridge_get_stp (NMSettingBridge *setting) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:priority property of the setting + * + * Since: 0.9.8 **/ guint16 nm_setting_bridge_get_priority (NMSettingBridge *setting) @@ -151,6 +163,8 @@ nm_setting_bridge_get_priority (NMSettingBridge *setting) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:forward-delay property of the setting + * + * Since: 0.9.8 **/ guint16 nm_setting_bridge_get_forward_delay (NMSettingBridge *setting) @@ -165,6 +179,8 @@ nm_setting_bridge_get_forward_delay (NMSettingBridge *setting) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:hello-time property of the setting + * + * Since: 0.9.8 **/ guint16 nm_setting_bridge_get_hello_time (NMSettingBridge *setting) @@ -179,6 +195,8 @@ nm_setting_bridge_get_hello_time (NMSettingBridge *setting) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:max-age property of the setting + * + * Since: 0.9.8 **/ guint16 nm_setting_bridge_get_max_age (NMSettingBridge *setting) @@ -193,6 +211,8 @@ nm_setting_bridge_get_max_age (NMSettingBridge *setting) * @setting: the #NMSettingBridge * * Returns: the #NMSettingBridge:ageing-time property of the setting + * + * Since: 0.9.8 **/ guint nm_setting_bridge_get_ageing_time (NMSettingBridge *setting) @@ -399,6 +419,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * NMSettingBridge:interface-name: * * The name of the virtual in-kernel briding network interface + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_INTERFACE_NAME, @@ -412,6 +434,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * NMSettingBridge:stp: * * Controls whether Spanning Tree Protocol (STP) is enabled for this bridge. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_STP, @@ -428,6 +452,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower * values are "better"; the lowest priority bridge will be elected the root * bridge. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_PRIORITY, @@ -444,6 +470,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * NMSettingBridge:forward-delay: * * The Spanning Tree Protocol (STP) forwarding delay, in seconds. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_FORWARD_DELAY, @@ -458,6 +486,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * NMSettingBridge:hello-time: * * The Spanning Tree Protocol (STP) hello time, in seconds. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_HELLO_TIME, @@ -472,6 +502,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * NMSettingBridge:max-age: * * The Spanning Tree Protocol (STP) maximum message age, in seconds. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_MAX_AGE, @@ -486,6 +518,8 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class) * NMSettingBridge:ageing-time: * * The ethernet MAC address aging time, in seconds. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_AGEING_TIME, diff --git a/libnm-util/nm-setting-bridge.h b/libnm-util/nm-setting-bridge.h index 7b9f92be9..b0b53fd5f 100644 --- a/libnm-util/nm-setting-bridge.h +++ b/libnm-util/nm-setting-bridge.h @@ -43,6 +43,8 @@ G_BEGIN_DECLS * @NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY: the property was invalid * @NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY: the property was missing and is * required + * + * Since: 0.9.8 */ typedef enum { NM_SETTING_BRIDGE_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/ diff --git a/libnm-util/nm-setting-connection.c b/libnm-util/nm-setting-connection.c index 1222f9763..d4de1253d 100644 --- a/libnm-util/nm-setting-connection.c +++ b/libnm-util/nm-setting-connection.c @@ -541,6 +541,8 @@ nm_setting_connection_is_slave_type (NMSettingConnection *setting, * @setting: the #NMSettingConnection * * Returns: the number of configured secondary connection UUIDs + * + * Since: 0.9.8 **/ guint32 nm_setting_connection_get_num_secondaries (NMSettingConnection *setting) @@ -556,6 +558,8 @@ nm_setting_connection_get_num_secondaries (NMSettingConnection *setting) * @idx: the zero-based index of the secondary connection UUID entry * * Returns: the secondary connection UUID at index @idx + * + * Since: 0.9.8 **/ const char * nm_setting_connection_get_secondary (NMSettingConnection *setting, guint32 idx) @@ -579,6 +583,8 @@ nm_setting_connection_get_secondary (NMSettingConnection *setting, guint32 idx) * * Returns: %TRUE if the secondary connection UUID was added; %FALSE if the UUID * was already present + * + * Since: 0.9.8 **/ gboolean nm_setting_connection_add_secondary (NMSettingConnection *setting, @@ -607,6 +613,8 @@ nm_setting_connection_add_secondary (NMSettingConnection *setting, * @idx: index number of the secondary connection UUID * * Removes the secondary coonnection UUID at index @idx. + * + * Since: 0.9.8 **/ void nm_setting_connection_remove_secondary (NMSettingConnection *setting, guint32 idx) @@ -1134,6 +1142,8 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class) * * List of connection UUIDs that should be activated when the base connection * itself is activated. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_SECONDARIES, diff --git a/libnm-util/nm-setting-ip6-config.c b/libnm-util/nm-setting-ip6-config.c index 00e27aeab..818571344 100644 --- a/libnm-util/nm-setting-ip6-config.c +++ b/libnm-util/nm-setting-ip6-config.c @@ -137,6 +137,8 @@ nm_setting_ip6_config_get_method (NMSettingIP6Config *setting) * property. * * Returns: the configured hostname to send to the DHCP server + * + * Since: 0.9.8 **/ const char * nm_setting_ip6_config_get_dhcp_hostname (NMSettingIP6Config *setting) @@ -903,6 +905,8 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class) * NMSettingIP6Config:dhcp-hostname: * * The specified name will be sent to the DHCP server when acquiring a lease. + * + * Since: 0.9.8 **/ g_object_class_install_property (object_class, PROP_DHCP_HOSTNAME, diff --git a/libnm-util/nm-setting-wireless.h b/libnm-util/nm-setting-wireless.h index 6e9c4d68f..e75bb1518 100644 --- a/libnm-util/nm-setting-wireless.h +++ b/libnm-util/nm-setting-wireless.h @@ -90,6 +90,8 @@ GQuark nm_setting_wireless_error_quark (void); * * Indicates AP/master mode where the wireless device is started as an access * point/hotspot. + * + * Since: 0.9.8 */ #define NM_SETTING_WIRELESS_MODE_AP "ap" diff --git a/libnm-util/nm-utils.c b/libnm-util/nm-utils.c index ca9f7f511..ee7531b24 100644 --- a/libnm-util/nm-utils.c +++ b/libnm-util/nm-utils.c @@ -1215,6 +1215,8 @@ device_supports_ap_ciphers (guint32 dev_caps, * * Returns: TRUE if the device capabilities are compatible with the desired * @type, FALSE if they are not. + * + * Since: 0.9.8 **/ gboolean nm_utils_ap_mode_security_valid (NMUtilsSecurityType type, @@ -1418,6 +1420,8 @@ nm_utils_security_valid (NMUtilsSecurityType type, * Checks if @key is a valid WEP key * * Returns: %TRUE if @key is a WEP key, %FALSE if not + * + * Since: 0.9.8 */ gboolean nm_utils_wep_key_valid (const char *key, NMWepKeyType wep_type) @@ -1459,6 +1463,8 @@ nm_utils_wep_key_valid (const char *key, NMWepKeyType wep_type) * Checks if @psk is a valid WPA PSK * * Returns: %TRUE if @psk is a WPA PSK, %FALSE if not + * + * Since: 0.9.8 */ gboolean nm_utils_wpa_psk_valid (const char *psk) @@ -2676,6 +2682,8 @@ nm_utils_hwaddr_ntoa (gconstpointer addr, int type) * function in net/core/dev.c. * * Returns: %TRUE if interface name is valid, otherwise %FALSE is returned. + * + * Since: 0.9.8 */ gboolean nm_utils_iface_valid_name (const char *name) @@ -2707,6 +2715,8 @@ nm_utils_iface_valid_name (const char *name) * Checks if @str is a UUID * * Returns: %TRUE if @str is a UUID, %FALSE if not + * + * Since: 0.9.8 */ gboolean nm_utils_is_uuid (const char *str)