diff options
| author | Philip Withnall <philip.withnall@collabora.co.uk> | 2014-07-18 08:44:41 +0100 |
|---|---|---|
| committer | Olivier Crête <olivier.crete@collabora.com> | 2014-08-08 15:52:45 -0400 |
| commit | f6b6cfe51cfc67add221428f97b13111fa73a606 (patch) | |
| tree | 092fc833fdb952477d04bf50a8971c81dc882aa9 /agent/interfaces.h | |
| parent | dce6020004d34778adbedfe3b8fb16627b31988d (diff) | |
| download | libnice-f6b6cfe51cfc67add221428f97b13111fa73a606.tar.gz | |
agent: Expand documentation for nice_interfaces_get_ip_for_interface()
Diffstat (limited to 'agent/interfaces.h')
| -rw-r--r-- | agent/interfaces.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/agent/interfaces.h b/agent/interfaces.h index e5fea18..cb76626 100644 --- a/agent/interfaces.h +++ b/agent/interfaces.h @@ -45,9 +45,11 @@ G_BEGIN_DECLS * nice_interfaces_get_ip_for_interface: * @interface_name: name of local interface * - * Retreives the IPv4 address of an interface by its name + * Retrieves the IP address of an interface by its name. If this fails, %NULL + * is returned. * - * Returns: a newly-allocated string with the IP address + * Returns: (nullable) (transfer full): a newly-allocated string with the IP + * address */ gchar * nice_interfaces_get_ip_for_interface (gchar *interface_name); |