Commit f6b6cfe5 authored by Philip Withnall's avatar Philip Withnall Committed by Olivier Crête

agent: Expand documentation for nice_interfaces_get_ip_for_interface()

parent dce60200
...@@ -45,9 +45,11 @@ G_BEGIN_DECLS ...@@ -45,9 +45,11 @@ G_BEGIN_DECLS
* nice_interfaces_get_ip_for_interface: * nice_interfaces_get_ip_for_interface:
* @interface_name: name of local 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); gchar * nice_interfaces_get_ip_for_interface (gchar *interface_name);
......
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