summaryrefslogtreecommitdiff
path: root/libnm
diff options
context:
space:
mode:
authorDan Winship <danw@redhat.com>2014-12-18 12:44:57 -0500
committerDan Winship <danw@redhat.com>2014-12-18 13:47:03 -0500
commit2d29c0527e6299658319d9779fd9ce891f8610f6 (patch)
treed2cf48af54c5b274021d7754e3103f262a0d9be3 /libnm
parentee65399030d0f5003ca82094f4c6cb869cbcbdd4 (diff)
downloadNetworkManager-2d29c0527e6299658319d9779fd9ce891f8610f6.tar.gz
docs: misc small fixes
Cleans up all of the warnings that aren't overly annoying to clean up.
Diffstat (limited to 'libnm')
-rw-r--r--libnm/nm-client.c6
-rw-r--r--libnm/nm-dhcp-config.c6
-rw-r--r--libnm/nm-ip-config.c6
3 files changed, 11 insertions, 7 deletions
diff --git a/libnm/nm-client.c b/libnm/nm-client.c
index 729dab62a6..ef73e329b2 100644
--- a/libnm/nm-client.c
+++ b/libnm/nm-client.c
@@ -702,9 +702,9 @@ nm_client_save_hostname_finish (NMClient *client,
* @client: a #NMClient
*
* Gets all the known network devices. Use nm_device_get_type() or the
- * NM_IS_DEVICE_XXXX() functions to determine what kind of device member of the
- * returned array is, and then you may use device-specific methods such as
- * nm_device_ethernet_get_hw_address().
+ * <literal>NM_IS_DEVICE_XXXX</literal> functions to determine what kind of
+ * device member of the returned array is, and then you may use device-specific
+ * methods such as nm_device_ethernet_get_hw_address().
*
* Returns: (transfer none) (element-type NMDevice): a #GPtrArray
* containing all the #NMDevices. The returned array is owned by the
diff --git a/libnm/nm-dhcp-config.c b/libnm/nm-dhcp-config.c
index 4a58bf27a6..7227abac33 100644
--- a/libnm/nm-dhcp-config.c
+++ b/libnm/nm-dhcp-config.c
@@ -143,7 +143,8 @@ nm_dhcp_config_class_init (NMDhcpConfigClass *config_class)
/**
* NMDhcpConfig:family:
*
- * The IP address family of the configuration; either %AF_INET or %AF_INET6.
+ * The IP address family of the configuration; either
+ * <literal>AF_INET</literal> or <literal>AF_INET6</literal>.
**/
g_object_class_install_property
(object_class, PROP_FAMILY,
@@ -173,7 +174,8 @@ nm_dhcp_config_class_init (NMDhcpConfigClass *config_class)
*
* Gets the IP address family of the configuration
*
- * Returns: the IP address family; either %AF_INET or %AF_INET6
+ * Returns: the IP address family; either <literal>AF_INET</literal> or
+ * <literal>AF_INET6</literal>
**/
int
nm_dhcp_config_get_family (NMDhcpConfig *config)
diff --git a/libnm/nm-ip-config.c b/libnm/nm-ip-config.c
index e8c450fa39..d057903e27 100644
--- a/libnm/nm-ip-config.c
+++ b/libnm/nm-ip-config.c
@@ -269,7 +269,8 @@ nm_ip_config_class_init (NMIPConfigClass *config_class)
/**
* NMIPConfig:family:
*
- * The IP address family of the configuration; either %AF_INET or %AF_INET6.
+ * The IP address family of the configuration; either
+ * <literal>AF_INET</literal> or <literal>AF_INET6</literal>.
**/
g_object_class_install_property
(object_class, PROP_FAMILY,
@@ -370,7 +371,8 @@ nm_ip_config_class_init (NMIPConfigClass *config_class)
*
* Gets the IP address family
*
- * Returns: the IP address family; either %AF_INET or %AF_INET6
+ * Returns: the IP address family; either <literal>AF_INET</literal> or
+ * <literal>AF_INET6</literal>
**/
int
nm_ip_config_get_family (NMIPConfig *config)