system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-22 02:35:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

libnm-util: fix gtk-doc bugs in NMSetting* properties

Browse source 
Fix misused gtk-doc annotations and incorrectly-identified properties.

In particular, the upcoming introspection-based generate-settings-spec
expands macro and enum values, so if you use '%' where you should have
used '#', it will fail to find an expansion, and error out.
This commit is contained in:
Dan Winship 2014-06-06 12:30:03 -04:00
parent 8487a4490c
commit 9de24b16e8
10 changed files with 45 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
libnm-util/nm-setting-8021x.c
View file

@ -3802,7 +3802,7 @@ nm_setting_802_1x_class_init (NMSetting8021xClass *setting_class)
/**
* NMSetting8021x:system-ca-certs:
*
* When TRUE, overrides #NMSetting8021x:ca-path and
* When %TRUE, overrides the #NMSetting8021x:ca-path and
* #NMSetting8021x:phase2-ca-path properties using the system CA directory
* specified at configure time with the --system-ca-path switch. The
* certificates in this directory are added to the verification chain in

4
libnm-util/nm-setting-connection.c
View file

@ -1204,7 +1204,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
* NMSettingConnection:permissions:
*
* An array of strings defining what access a given user has to this
* connection. If this is NULL or empty, all users are allowed to access
* connection. If this is %NULL or empty, all users are allowed to access
* this connection. Otherwise a user is allowed to access this connection
* if and only if they are in this list. Each entry is of the form
* "[type]:[id]:[reserved]", for example:
@ -1300,7 +1300,7 @@ nm_setting_connection_class_init (NMSettingConnectionClass *setting_class)
*
* The trust level of a the connection.
* Free form case-insensitive string (for example "Home", "Work", "Public").
* NULL or unspecified zone means the connection will be placed in the
* %NULL or unspecified zone means the connection will be placed in the
* default zone as defined by the firewall.
**/
g_object_class_install_property

14
libnm-util/nm-setting-dcb.c
View file

@ -961,7 +961,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
/**
* NMSettingDcb:app-fcoe-flags:
*
* Specifies the %NMSettingDcbFlags for the DCB FCoE application.
* Specifies the #NMSettingDcbFlags for the DCB FCoE application.
*
* Since: 0.9.10
**/
@ -1015,7 +1015,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
/**
* NMSettingDcb:app-iscsi-flags:
*
* Specifies the %NMSettingDcbFlags for the DCB iSCSI application.
* Specifies the #NMSettingDcbFlags for the DCB iSCSI application.
*
* Since: 0.9.10
**/
@ -1051,7 +1051,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
/**
* NMSettingDcb:app-fip-flags:
*
* Specifies the %NMSettingDcbFlags for the DCB FIP application.
* Specifies the #NMSettingDcbFlags for the DCB FIP application.
*
* Since: 0.9.10
**/
@ -1087,7 +1087,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
/**
* NMSettingDcb:priority-flow-control-flags:
*
* Specifies the %NMSettingDcbFlags for DCB Priority Flow Control (PFC).
* Specifies the #NMSettingDcbFlags for DCB Priority Flow Control (PFC).
*
* Since: 0.9.10
**/
@ -1127,7 +1127,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
/**
* NMSettingDcb:priority-group-flags:
*
* Specifies the %NMSettingDcbFlags for DCB Priority Groups.
* Specifies the #NMSettingDcbFlags for DCB Priority Groups.
*
* Since: 0.9.10
**/
@ -1210,7 +1210,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
G_PARAM_READWRITE));
/**
* NMSettingDcb:priority-strict:
* NMSettingDcb:priority-strict-bandwidth:
*
* An array of 8 uint values, where the array index corresponds to the
* User Priority (0 - 7) and the value indicates whether or not the
@ -1223,7 +1223,7 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
g_object_class_install_property
(object_class, PROP_PRIORITY_STRICT,
_nm_param_spec_specialized (NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH,
"Priority Strict",
"Priority Strict Bandwidth",
"An array of 8 uint values, where the array index "
"corresponds to the User Priority (0 - 7) and the "
"value indicates whether or not the priority may "

2
libnm-util/nm-setting-gsm.c
View file

@ -745,7 +745,7 @@ nm_setting_gsm_class_init (NMSettingGsmClass *setting_class)
/**
* NMSettingGsm:home-only:
*
* When TRUE, only connections to the home network will be allowed.
* When %TRUE, only connections to the home network will be allowed.
* Connections to roaming networks will not be made.
**/
g_object_class_install_property

14
libnm-util/nm-setting-ip4-config.c
View file

@ -1380,7 +1380,7 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
/**
* NMSettingIP4Config:ignore-auto-routes:
*
* When the method is set to 'auto' and this property to TRUE, automatically
* When the method is set to 'auto' and this property to %TRUE, automatically
* configured routes are ignored and only routes specified in
* #NMSettingIP4Config:routes, if any, are used.
**/
@ -1398,7 +1398,7 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
/**
* NMSettingIP4Config:ignore-auto-dns:
*
* When the method is set to 'auto' and this property to TRUE, automatically
* When the method is set to 'auto' and this property to %TRUE, automatically
* configured nameservers and search domains are ignored and only nameservers
* and search domains specified in #NMSettingIP4Config:dns and
* #NMSettingIP4Config:dns-search, if any, are used.
@ -1434,7 +1434,7 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
/**
* NMSettingIP4Config:dhcp-send-hostname:
*
* If TRUE, a hostname is sent to the DHCP server when acquiring a lease.
* If %TRUE, a hostname is sent to the DHCP server when acquiring a lease.
* Some DHCP servers use this hostname to update DNS databases, essentially
* providing a static hostname for the computer. If
* #NMSettingIP4Config:dhcp-hostname is empty and this property is TRUE,
@ -1457,7 +1457,7 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
/**
* NMSettingIP4Config:dhcp-hostname:
*
* If the #NMSettingIP4Config:dhcp-send-hostname property is TRUE, then the
* If the #NMSettingIP4Config:dhcp-send-hostname property is %TRUE, then the
* specified name will be sent to the DHCP server when acquiring a lease.
**/
g_object_class_install_property
@ -1473,7 +1473,7 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
/**
* NMSettingIP4Config:never-default:
*
* If TRUE, this connection will never be the default IPv4 connection,
* If %TRUE, this connection will never be the default IPv4 connection,
* meaning it will never be assigned the default route by NetworkManager.
**/
g_object_class_install_property
@ -1489,10 +1489,10 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *setting_class)
/**
* NMSettingIP4Config:may-fail:
*
* If TRUE, allow overall network configuration to proceed even if IPv4
* If %TRUE, allow overall network configuration to proceed even if IPv4
* configuration times out. Note that at least one IP configuration
* must succeed or overall network configuration will still fail. For
* example, in IPv6-only networks, setting this property to TRUE allows
* example, in IPv6-only networks, setting this property to %TRUE allows
* the overall network configuration to succeed if IPv4 configuration fails
* but IPv6 configuration completes successfully.
**/

10
libnm-util/nm-setting-ip6-config.c
View file

@ -1190,7 +1190,7 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
* NMSettingIP6Config:ignore-auto-routes:
*
* When the method is set to 'auto' or 'dhcp' and this property is set to
* TRUE, automatically configured routes are ignored and only routes
* %TRUE, automatically configured routes are ignored and only routes
* specified in #NMSettingIP6Config:routes, if any, are used.
**/
g_object_class_install_property
@ -1208,7 +1208,7 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
* NMSettingIP6Config:ignore-auto-dns:
*
* When the method is set to 'auto' or 'dhcp' and this property is set to
* TRUE, automatically configured nameservers and search domains are ignored
* %TRUE, automatically configured nameservers and search domains are ignored
* and only nameservers and search domains specified in
* #NMSettingIP6Config:dns and #NMSettingIP6Config:dns-search, if any, are
* used.
@ -1228,7 +1228,7 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
/**
* NMSettingIP6Config:never-default:
*
* If TRUE, this connection will never be the default IPv6 connection,
* If %TRUE, this connection will never be the default IPv6 connection,
* meaning it will never be assigned the default IPv6 route by NetworkManager.
**/
g_object_class_install_property
@ -1244,10 +1244,10 @@ nm_setting_ip6_config_class_init (NMSettingIP6ConfigClass *setting_class)
/**
* NMSettingIP6Config:may-fail:
*
* If TRUE, allow overall network configuration to proceed even if IPv6
* If %TRUE, allow overall network configuration to proceed even if IPv6
* configuration times out. Note that at least one IP configuration
* must succeed or overall network configuration will still fail. For
* example, in IPv4-only networks, setting this property to TRUE allows
* example, in IPv4-only networks, setting this property to %TRUE allows
* the overall network configuration to succeed if IPv6 configuration fails
* but IPv4 configuration completes successfully.
**/

36
libnm-util/nm-setting-ppp.c
View file

@ -566,9 +566,9 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:noauth:
*
* If TRUE, do not require the other side (usually the PPP server) to
* authenticate itself to the client. If FALSE, require authentication from
* the remote side. In almost all cases, this should be TRUE.
* If %TRUE, do not require the other side (usually the PPP server) to
* authenticate itself to the client. If %FALSE, require authentication from
* the remote side. In almost all cases, this should be %TRUE.
**/
g_object_class_install_property
(object_class, PROP_NOAUTH,
@ -584,7 +584,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:refuse-eap:
*
* If TRUE, the EAP authentication method will not be used.
* If %TRUE, the EAP authentication method will not be used.
**/
g_object_class_install_property
(object_class, PROP_REFUSE_EAP,
@ -597,7 +597,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:refuse-pap:
*
* If TRUE, the PAP authentication method will not be used.
* If %TRUE, the PAP authentication method will not be used.
**/
g_object_class_install_property
(object_class, PROP_REFUSE_PAP,
@ -610,7 +610,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:refuse-chap:
*
* If TRUE, the CHAP authentication method will not be used.
* If %TRUE, the CHAP authentication method will not be used.
**/
g_object_class_install_property
(object_class, PROP_REFUSE_CHAP,
@ -623,7 +623,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:refuse-mschap:
*
* If TRUE, the MSCHAP authentication method will not be used.
* If %TRUE, the MSCHAP authentication method will not be used.
**/
g_object_class_install_property
(object_class, PROP_REFUSE_MSCHAP,
@ -636,7 +636,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:refuse-mschapv2:
*
* If TRUE, the MSCHAPv2 authentication method will not be used.
* If %TRUE, the MSCHAPv2 authentication method will not be used.
**/
g_object_class_install_property
(object_class, PROP_REFUSE_MSCHAPV2,
@ -649,7 +649,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:nobsdcomp:
*
* If TRUE, BSD compression will not be requested.
* If %TRUE, BSD compression will not be requested.
**/
g_object_class_install_property
(object_class, PROP_NOBSDCOMP,
@ -662,7 +662,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:nodeflate:
*
* If TRUE, 'deflate' compression will not be requested.
* If %TRUE, 'deflate' compression will not be requested.
**/
g_object_class_install_property
(object_class, PROP_NODEFLATE,
@ -675,7 +675,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:no-vj-comp:
*
* If TRUE, Van Jacobsen TCP header compression will not be requested.
* If %TRUE, Van Jacobsen TCP header compression will not be requested.
**/
g_object_class_install_property
(object_class, PROP_NO_VJ_COMP,
@ -688,7 +688,7 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:require-mppe:
*
* If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for
* If %TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for
* the PPP session. If either 64-bit or 128-bit MPPE is not available the
* session will fail. Note that MPPE is not used on mobile broadband
* connections.
@ -708,9 +708,9 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:require-mppe-128:
*
* If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be
* If %TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be
* required for the PPP session, and the 'require-mppe' property must also
* be set to TRUE. If 128-bit MPPE is not available the session will fail.
* be set to %TRUE. If 128-bit MPPE is not available the session will fail.
**/
g_object_class_install_property
(object_class, PROP_REQUIRE_MPPE_128,
@ -727,8 +727,8 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:mppe-stateful:
*
* If TRUE, stateful MPPE is used. See pppd documentation for more
* information on stateful MPPE.",
* If %TRUE, stateful MPPE is used. See pppd documentation for more
* information on stateful MPPE.
**/
g_object_class_install_property
(object_class, PROP_MPPE_STATEFUL,
@ -742,9 +742,9 @@ nm_setting_ppp_class_init (NMSettingPPPClass *setting_class)
/**
* NMSettingPPP:crtscts:
*
* If TRUE, specify that pppd should set the serial port to use hardware
* If %TRUE, specify that pppd should set the serial port to use hardware
* flow control with RTS and CTS signals. This value should normally be
* set to FALSE.
* set to %FALSE.
**/
g_object_class_install_property
(object_class, PROP_CRTSCTS,

2
libnm-util/nm-setting-vlan.c
View file

@ -808,7 +808,7 @@ nm_setting_vlan_class_init (NMSettingVlanClass *setting_class)
/**
* NMSettingVlan:flags:
*
* One or more of %NMVlanFlags which control the behavior and features of
* One or more of #NMVlanFlags which control the behavior and features of
* the VLAN interface.
**/
g_object_class_install_property

4
libnm-util/nm-setting-wired.c
View file

@ -919,9 +919,9 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_class)
G_PARAM_READWRITE));
/**
* NMSettingEthernet:auto-negotiate:
* NMSettingWired:auto-negotiate:
*
* If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE,
* If %TRUE, allow auto-negotiation of port speed and duplex mode. If %FALSE,
* do not allow auto-negotiation, in which case the 'speed' and 'duplex'
* properties should be set.
**/

2
libnm-util/nm-setting-wireless-security.c
View file

@ -1634,7 +1634,7 @@ nm_setting_wireless_security_class_init (NMSettingWirelessSecurityClass *setting
* NMSettingWirelessSecurity:wep-key-type:
*
* Controls the interpretation of WEP keys. Allowed values are those given
* by %NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be
* by #NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be
* either 10 or 26 characters in length. If set to 1 and the keys are
* ASCII keys, they must be either 5 or 13 characters in length. If set to
* 2, the passphrase is hashed using the de-facto MD5 method to derive the