diff options
| author | Daniel Teichmann <daniel.teichmann@das-netzwerkteam.de> | 2021-09-27 14:45:15 +0300 |
|---|---|---|
| committer | Daniel Teichmann <daniel.teichmann@das-netzwerkteam.de> | 2021-10-01 15:17:27 +0300 |
| commit | 170fbfffb013c1d2f08857f55bd2d44a289810e0 (patch) | |
| tree | 0a61c0bd769c2c5da809024cc1c6764ca03e0124 /plugins | |
| parent | b73a0633441b2c99725e6c9bd83bf2279be45bc2 (diff) | |
x2go_plugin.c: Add docstrings to validator functions.
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/x2go/x2go_plugin.c | 27 |
1 files changed, 24 insertions, 3 deletions
diff --git a/plugins/x2go/x2go_plugin.c b/plugins/x2go/x2go_plugin.c index 3789b746e..fc5ccc2fd 100644 --- a/plugins/x2go/x2go_plugin.c +++ b/plugins/x2go/x2go_plugin.c @@ -1246,9 +1246,16 @@ static const RemminaProtocolFeature remmina_plugin_x2go_features[] = { }; /** - * @brief Gets executed when the user wants to save profile settings. - * It uses the given data (See RemminaProtocolSetting array) to determine - * which strings are allowed. + * @brief Validator-functions are getting executed when the user wants to save profile + * settings. It uses the given data (See RemminaProtocolSetting array) to determine + * which strings are allowed and returns a end-user friendly error message. + * + * @param key Key is the setting's name. + * @param value Value to validate. + * @param data Data needed for validation process. See RemminaProtocolSetting array. + * + * @returns End-user friendly and translated error message, explaining why the given + * value is invalid. If the given value is error-free then NULL gets returned. * */ static GError* remmina_plugin_x2go_string_setting_validator(gchar* key, @@ -1294,6 +1301,20 @@ static GError* remmina_plugin_x2go_string_setting_validator(gchar* key, return error; } +/** + * @brief Validator-functions are getting executed when the user wants to save profile + * settings. It uses the given data (See RemminaProtocolSetting array) to determine + * if the given value is a valid integer is in range and returns + * a end-user friendly error message. + * + * @param key Key is the setting's name. + * @param value Value to validate. + * @param data Data needed for validation process. See RemminaProtocolSetting array. + * + * @returns End-user friendly and translated error message, explaining why the given + * value is invalid. If the given value is error-free then NULL gets returned. + * + */ static GError* remmina_plugin_x2go_int_setting_validator(gchar* key, gpointer value, gchar* data) { |