Commit 4f9e13fc authored by Dan Williams's avatar Dan Williams

libnm-glib: add Since tags to new functions and properties

parent 87355059
......@@ -1056,6 +1056,8 @@ nm_client_get_permission_result (NMClient *client, NMClientPermission permission
* Gets NetworkManager current logging level and domains.
*
* Returns: %TRUE on success, %FALSE otherwise
*
* Since: 0.9.8
**/
gboolean
nm_client_get_logging (NMClient *client, char **level, char **domains, GError **error)
......@@ -1095,6 +1097,8 @@ nm_client_get_logging (NMClient *client, char **level, char **domains, GError **
* Sets NetworkManager logging level and/or domains.
*
* Returns: %TRUE on success, %FALSE otherwise
*
* Since: 0.9.8
**/
gboolean
nm_client_set_logging (NMClient *client, const char *level, const char *domains, GError **error)
......
......@@ -337,6 +337,8 @@ nm_device_bond_class_init (NMDeviceBondClass *eth_class)
* NMDeviceBond:slaves:
*
* The devices (#NMDevice) slaved to the bond device.
*
* Since: 0.9.8
**/
g_object_class_install_property
(object_class, PROP_SLAVES,
......
......@@ -66,6 +66,8 @@ enum {
* Registers an error quark for #NMDeviceBridge if necessary.
*
* Returns: the error quark used for #NMDeviceBridge errors.
*
* Since: 0.9.8
**/
GQuark
nm_device_bridge_error_quark (void)
......@@ -85,6 +87,8 @@ nm_device_bridge_error_quark (void)
* Creates a new #NMDeviceBridge.
*
* Returns: (transfer full): a new device
*
* Since: 0.9.8
**/
GObject *
nm_device_bridge_new (DBusGConnection *connection, const char *path)
......@@ -110,6 +114,8 @@ nm_device_bridge_new (DBusGConnection *connection, const char *path)
*
* Returns: the hardware address. This is the internal string used by the
* device, and must not be modified.
*
* Since: 0.9.8
**/
const char *
nm_device_bridge_get_hw_address (NMDeviceBridge *device)
......@@ -127,6 +133,8 @@ nm_device_bridge_get_hw_address (NMDeviceBridge *device)
* Whether the device has carrier.
*
* Returns: %TRUE if the device has carrier
*
* Since: 0.9.8
**/
gboolean
nm_device_bridge_get_carrier (NMDeviceBridge *device)
......@@ -146,6 +154,8 @@ nm_device_bridge_get_carrier (NMDeviceBridge *device)
* Returns: (element-type NMClient.Device): the #GPtrArray containing
* #NMDevice<!-- -->s that are slaves of @device. This is the internal
* copy used by the device, and must not be modified.
*
* Since: 0.9.8
**/
const GPtrArray *
nm_device_bridge_get_slaves (NMDeviceBridge *device)
......@@ -309,6 +319,8 @@ nm_device_bridge_class_init (NMDeviceBridgeClass *bridge_class)
* NMDeviceBridge:hw-address:
*
* The hardware (MAC) address of the device.
*
* Since: 0.9.8
**/
g_object_class_install_property
(object_class, PROP_HW_ADDRESS,
......@@ -322,6 +334,8 @@ nm_device_bridge_class_init (NMDeviceBridgeClass *bridge_class)
* NMDeviceBridge:carrier:
*
* Whether the device has carrier.
*
* Since: 0.9.8
**/
g_object_class_install_property
(object_class, PROP_CARRIER,
......@@ -335,6 +349,8 @@ nm_device_bridge_class_init (NMDeviceBridgeClass *bridge_class)
* NMDeviceBridge:slaves:
*
* The devices (#NMDevice) slaved to the bridge device.
*
* Since: 0.9.8
**/
g_object_class_install_property
(object_class, PROP_SLAVES,
......
......@@ -40,6 +40,8 @@ G_BEGIN_DECLS
* @NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION: the connection was not of bridge type
* @NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION: the bridge connection was invalid
* @NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH: the interfaces of the connection and the device mismatched
*
* Since: 0.9.8
*/
typedef enum {
NM_DEVICE_BRIDGE_ERROR_UNKNOWN = 0, /*< nick=UnknownError >*/
......
......@@ -356,6 +356,7 @@ request_scan_cb (DBusGProxy *proxy,
* instructs NM to perform scanning. Use nm_device_wifi_get_access_points()
* to get available access points.
*
* Since: 0.9.8
**/
void
nm_device_wifi_request_scan_simple (NMDeviceWifi *device,
......
......@@ -738,6 +738,8 @@ nm_device_class_init (NMDeviceClass *device_class)
* NMDevice:available-connections:
*
* The available connections (#NMRemoteConnection) of the device
*
* Since: 0.9.8
**/
g_object_class_install_property
(object_class, PROP_AVAILABLE_CONNECTIONS,
......@@ -1296,6 +1298,8 @@ nm_device_get_active_connection (NMDevice *device)
* Returns: (element-type NMClient.RemoteConnection): the #GPtrArray
* containing #NMRemoteConnections. This is the internal copy used by
* the connection, and must not be modified.
*
* Since: 0.9.8
**/
const GPtrArray *
nm_device_get_available_connections (NMDevice *device)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment