fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-01-01 06:00:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: use %TRUE, %FALSE macros instead of plain TRUE, FALSE values for gtkdoc

Browse source
This commit is contained in:
Jiří Klimeš 2014-02-24 16:58:00 +01:00
parent 8a67713e9e
commit c2a1cb1a44
8 changed files with 40 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
libnm-glib/nm-remote-settings.c
View file

@ -569,7 +569,7 @@ add_connection_done (DBusGProxy *proxy, DBusGProxyCall *call, gpointer user_data
* Requests that the remote settings service add the given settings to a new
* connection. The connection is immediately written to disk.
*
* Returns: TRUE if the request was successful, FALSE if it failed
* Returns: %TRUE if the request was successful, %FALSE if it failed
**/
gboolean
nm_remote_settings_add_connection (NMRemoteSettings *settings,
@ -831,7 +831,7 @@ save_hostname_cb (DBusGProxy *proxy,
* Requests that the machine's persistent hostname be set to the specified value
* or cleared.
*
* Returns: TRUE if the request was successful, FALSE if it failed
* Returns: %TRUE if the request was successful, %FALSE if it failed
**/
gboolean
nm_remote_settings_save_hostname (NMRemoteSettings *settings,

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

@ -229,7 +229,7 @@ nm_setting_802_1x_get_eap_method (NMSetting8021x *setting, guint32 i)
* EAP method has been added. See #NMSetting8021x:eap property for a list of
* allowed EAP methods.
*
* Returns: TRUE if the EAP method was successfully added, FALSE if it was
* Returns: %TRUE if the EAP method was successfully added, %FALSE if it was
* not a valid method or if it was already allowed.
**/
gboolean
@ -374,11 +374,11 @@ nm_setting_802_1x_get_ca_path (NMSetting8021x *setting)
* Sets the #NMSetting8021x:system-ca-certs property. The
* #NMSetting8021x:ca-path and #NMSetting8021x:phase2-ca-path
* properties are ignored if the #NMSetting8021x:system-ca-certs property is
* TRUE, in which case a system-wide CA certificate directory specified at
* %TRUE, in which case a system-wide CA certificate directory specified at
* compile time (using the --system-ca-path configure option) is used in place
* of these properties.
*
* Returns: TRUE if a system CA certificate path should be used, FALSE if not
* Returns: %TRUE if a system CA certificate path should be used, %FALSE if not
**/
gboolean
nm_setting_802_1x_get_system_ca_certs (NMSetting8021x *setting)
@ -504,7 +504,7 @@ path_to_scheme_value (const char *path)
* scheme, or with the path to the certificate file if using the
* %NM_SETTING_802_1X_CK_SCHEME_PATH scheme.
*
* Returns: TRUE if the operation succeeded, FALSE if it was unsuccessful
* Returns: %TRUE if the operation succeeded, %FALSE if it was unsuccessful
**/
gboolean
nm_setting_802_1x_set_ca_cert (NMSetting8021x *setting,
@ -633,8 +633,8 @@ nm_setting_802_1x_get_altsubject_match (NMSetting8021x *setting, guint32 i)
* match is added, the altSubjectName of the remote authentication
* server is not verified.
*
* Returns: TRUE if the alternative subject name match was
* successfully added, FALSE if it was already allowed.
* Returns: %TRUE if the alternative subject name match was
* successfully added, %FALSE if it was already allowed.
**/
gboolean
nm_setting_802_1x_add_altsubject_match (NMSetting8021x *setting,
@ -785,7 +785,7 @@ nm_setting_802_1x_get_client_cert_path (NMSetting8021x *setting)
* when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x
* authentication method.
*
* Returns: TRUE if the operation succeeded, FALSE if it was unsuccessful
* Returns: %TRUE if the operation succeeded, %FALSE if it was unsuccessful
**/
gboolean
nm_setting_802_1x_set_client_cert (NMSetting8021x *setting,
@ -1049,7 +1049,7 @@ nm_setting_802_1x_get_phase2_ca_cert_path (NMSetting8021x *setting)
* %NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate
* file if using the %NM_SETTING_802_1X_CK_SCHEME_PATH scheme.
*
* Returns: TRUE if the operation succeeded, FALSE if it was unsuccessful
* Returns: %TRUE if the operation succeeded, %FALSE if it was unsuccessful
**/
gboolean
nm_setting_802_1x_set_phase2_ca_cert (NMSetting8021x *setting,
@ -1179,8 +1179,8 @@ nm_setting_802_1x_get_phase2_altsubject_match (NMSetting8021x *setting, guint32
* at least one match is added, the altSubjectName of the "phase 2"
* remote authentication server is not verified.
*
* Returns: TRUE if the "phase 2" alternative subject name match was
* successfully added, FALSE if it was already allowed.
* Returns: %TRUE if the "phase 2" alternative subject name match was
* successfully added, %FALSE if it was already allowed.
**/
gboolean
nm_setting_802_1x_add_phase2_altsubject_match (NMSetting8021x *setting,
@ -1334,7 +1334,7 @@ nm_setting_802_1x_get_phase2_client_cert_path (NMSetting8021x *setting)
* when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x
* authentication method.
*
* Returns: TRUE if the operation succeeded, FALSE if it was unsuccessful
* Returns: %TRUE if the operation succeeded, %FALSE if it was unsuccessful
**/
gboolean
nm_setting_802_1x_set_phase2_client_cert (NMSetting8021x *setting,
@ -1624,7 +1624,7 @@ file_to_byte_array (const char *filename)
* unprivileged users. Private keys should always be encrypted with a private
* key password to prevent unauthorized access to unencrypted private key data.
*
* Returns: TRUE if the operation succeeded, FALSE if it was unsuccessful
* Returns: %TRUE if the operation succeeded, %FALSE if it was unsuccessful
**/
gboolean
nm_setting_802_1x_set_private_key (NMSetting8021x *setting,
@ -1932,7 +1932,7 @@ nm_setting_802_1x_get_phase2_private_key_path (NMSetting8021x *setting)
* unprivileged users. Private keys should always be encrypted with a private
* key password to prevent unauthorized access to unencrypted private key data.
*
* Returns: TRUE if the operation succeeded, FALSE if it was unsuccessful
* Returns: %TRUE if the operation succeeded, %FALSE if it was unsuccessful
**/
gboolean
nm_setting_802_1x_set_phase2_private_key (NMSetting8021x *setting,

6
libnm-util/nm-setting-bond.c
View file

@ -287,10 +287,10 @@ validate_ifname (const char *name, const char *value)
* @value: the value of the option to validate
*
* Checks whether @name is a valid bond option and @value is a valid value for
* the @name. If @value is NULL, the function only validates the option name.
* the @name. If @value is %NULL, the function only validates the option name.
*
* Returns: TRUE, if the @value is valid for the given name.
* If the @name is not a valid option, FALSE will be returned.
* Returns: %TRUE, if the @value is valid for the given name.
* If the @name is not a valid option, %FALSE will be returned.
*
* Since: 0.9.10
**/

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

@ -383,8 +383,8 @@ nm_setting_connection_permissions_user_allowed (NMSettingConnection *setting,
* the "user" permission type is supported, and @pitem must be a username. See
* #NMSettingConnection:permissions: for more details.
*
* Returns: TRUE if the permission was unique and was successfully added to the
* list, FALSE if @ptype or @pitem was invalid or it the permission was already
* Returns: %TRUE if the permission was unique and was successfully added to the
* list, %FALSE if @ptype or @pitem was invalid or it the permission was already
* present in the list
*/
gboolean
@ -551,7 +551,7 @@ nm_setting_connection_get_slave_type (NMSettingConnection *setting)
* @type: the setting name (ie #NM_SETTING_BOND_SETTING_NAME) to be matched
* against @setting's slave type
*
* Returns: TRUE if connection is of the given slave @type
* Returns: %TRUE if connection is of the given slave @type
*/
gboolean
nm_setting_connection_is_slave_type (NMSettingConnection *setting,

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

@ -242,8 +242,8 @@ set_map (NMSettingVlan *self, NMVlanPriorityMap map, GSList *list)
* or the #NMSettingVlan:egress_priority_map properties. The priority map maps
* the Linux SKB priorities to 802.1p priorities.
*
* Returns: TRUE if the entry was successfully added to the list, or it
* overwrote the old value, FALSE if error
* Returns: %TRUE if the entry was successfully added to the list, or it
* overwrote the old value, %FALSE if error
*/
gboolean
nm_setting_vlan_add_priority_str (NMSettingVlan *setting,
@ -357,8 +357,8 @@ nm_setting_vlan_get_priority (NMSettingVlan *setting,
* If @map is #NM_VLAN_EGRESS_MAP then @from is the Linux SKB priority value and
* @to is the outgoing 802.1q VLAN Priority Code Point (PCP) value.
*
* Returns: TRUE if the new priority mapping was successfully added to the
* list, FALSE if error
* Returns: %TRUE if the new priority mapping was successfully added to the
* list, %FALSE if error
*/
gboolean
nm_setting_vlan_add_priority (NMSettingVlan *setting,

8
libnm-util/nm-setting.c
View file

@ -1109,8 +1109,8 @@ get_secret_flags (NMSetting *setting,
* For a given secret, retrieves the #NMSettingSecretFlags describing how to
* handle that secret.
*
* Returns: TRUE on success (if the given secret name was a valid property of
* this setting, and if that property is secret), FALSE if not
* Returns: %TRUE on success (if the given secret name was a valid property of
* this setting, and if that property is secret), %FALSE if not
**/
gboolean
nm_setting_get_secret_flags (NMSetting *setting,
@ -1152,8 +1152,8 @@ set_secret_flags (NMSetting *setting,
* For a given secret, stores the #NMSettingSecretFlags describing how to
* handle that secret.
*
* Returns: TRUE on success (if the given secret name was a valid property of
* this setting, and if that property is secret), FALSE if not
* Returns: %TRUE on success (if the given secret name was a valid property of
* this setting, and if that property is secret), %FALSE if not
**/
gboolean
nm_setting_set_secret_flags (NMSetting *setting,

20
libnm-util/nm-utils.c
View file

@ -219,7 +219,7 @@ static gboolean initialized = FALSE;
* is performed, but calling nm_utils_deinit() to explicitly deinitialize
* libnm-util can also be done. This function can be called more than once.
*
* Returns: TRUE if the initialization was successful, FALSE on failure.
* Returns: %TRUE if the initialization was successful, %FALSE on failure.
**/
gboolean
nm_utils_init (GError **error)
@ -334,7 +334,7 @@ nm_utils_ssid_to_utf8 (const GByteArray *ssid)
* AP's SSID. This function attempts to detect blank/empty SSIDs using a
* number of known SSID-cloaking methods.
*
* Returns: TRUE if the SSID is "empty", FALSE if it is not
* Returns: %TRUE if the SSID is "empty", %FALSE if it is not
**/
gboolean
nm_utils_is_empty_ssid (const guint8 * ssid, int len)
@ -396,7 +396,7 @@ nm_utils_escape_ssid (const guint8 * ssid, guint32 len)
* nm_utils_same_ssid:
* @ssid1: first SSID data to compare
* @ssid2: second SSID data to compare
* @ignore_trailing_null: TRUE to ignore one trailing NULL byte
* @ignore_trailing_null: %TRUE to ignore one trailing NULL byte
*
* Earlier versions of the Linux kernel added a NULL byte to the end of the
* SSID to enable easy printing of the SSID on the console or in a terminal,
@ -405,7 +405,7 @@ nm_utils_escape_ssid (const guint8 * ssid, guint32 len)
* cost of some compatibility with odd SSIDs that may legitimately have trailing
* NULLs, even though that is functionally pointless.
*
* Returns: TRUE if the SSIDs are the same, FALSE if they are not
* Returns: %TRUE if the SSIDs are the same, %FALSE if they are not
**/
gboolean
nm_utils_same_ssid (const GByteArray * ssid1,
@ -604,8 +604,8 @@ device_supports_ap_ciphers (guint32 dev_caps,
* against, determines whether the combination of device capabilities and
* desired security type are valid for AP/Hotspot connections.
*
* Returns: TRUE if the device capabilities are compatible with the desired
* @type, FALSE if they are not.
* Returns: %TRUE if the device capabilities are compatible with the desired
* @type, %FALSE if they are not.
*
* Since: 0.9.8
**/
@ -652,8 +652,8 @@ nm_utils_ap_mode_security_valid (NMUtilsSecurityType type,
* NOTE: this function cannot handle checking security for AP/Hotspot mode;
* use nm_utils_ap_mode_security_valid() instead.
*
* Returns: TRUE if the device capabilities and AP capabilties intersect and are
* compatible with the desired @type, FALSE if they are not
* Returns: %TRUE if the device capabilities and AP capabilties intersect and are
* compatible with the desired @type, %FALSE if they are not
**/
gboolean
nm_utils_security_valid (NMUtilsSecurityType type,
@ -1653,7 +1653,7 @@ out:
*
* Utility function to find out if the @filename is in PKCS#12 format.
*
* Returns: TRUE if the file is PKCS#12, FALSE if it is not
* Returns: %TRUE if the file is PKCS#12, %FALSE if it is not
**/
gboolean
nm_utils_file_is_pkcs12 (const char *filename)
@ -1846,7 +1846,7 @@ nm_utils_wifi_find_next_channel (guint32 channel, int direction, char *band)
*
* Utility function to verify WiFi channel validity.
*
* Returns: TRUE or FALSE
* Returns: %TRUE or %FALSE
**/
gboolean
nm_utils_wifi_is_channel_valid (guint32 channel, const char *band)

2
src/settings/nm-settings-connection.c
View file

@ -1764,7 +1764,7 @@ nm_settings_connection_get_seen_bssids (NMSettingsConnection *connection)
* @connection: the #NMSettingsConnection
* @bssid: the BSSID to check the seen BSSID list for
*
* Returns: TRUE if the given @bssid is in the seen BSSIDs list
* Returns: %TRUE if the given @bssid is in the seen BSSIDs list
**/
gboolean
nm_settings_connection_has_seen_bssid (NMSettingsConnection *connection,