diff options
| author | Michal Ratajsky <[email protected]> | 2014-09-05 16:36:05 +0200 |
|---|---|---|
| committer | Michal Ratajsky <[email protected]> | 2014-09-05 16:36:05 +0200 |
| commit | 1a9410a38aebb6ce05d43433c020e198416761df (patch) | |
| tree | b2db9e589c88585063101d87388fd515217214de /libmatemixer/matemixer-switch-option.c | |
| parent | b100e0045c0cb0b60bc381bc99dca18db82f3eba (diff) | |
| download | libmatemixer-1a9410a38aebb6ce05d43433c020e198416761df.tar.bz2 libmatemixer-1a9410a38aebb6ce05d43433c020e198416761df.tar.xz | |
Documentation additions and fixes
Diffstat (limited to 'libmatemixer/matemixer-switch-option.c')
| -rw-r--r-- | libmatemixer/matemixer-switch-option.c | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/libmatemixer/matemixer-switch-option.c b/libmatemixer/matemixer-switch-option.c index b20f92b..4c0e0fa 100644 --- a/libmatemixer/matemixer-switch-option.c +++ b/libmatemixer/matemixer-switch-option.c @@ -69,6 +69,12 @@ mate_mixer_switch_option_class_init (MateMixerSwitchOptionClass *klass) object_class->get_property = mate_mixer_switch_option_get_property; object_class->set_property = mate_mixer_switch_option_set_property; + /** + * MateMixerSwitchOption:name: + * + * The name of the switch option. The name serves as a unique identifier + * and in most cases it is not in a user-readable form. + */ properties[PROP_NAME] = g_param_spec_string ("name", "Name", @@ -78,6 +84,12 @@ mate_mixer_switch_option_class_init (MateMixerSwitchOptionClass *klass) G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS); + /** + * MateMixerSwitchOption:label: + * + * The label of the switch option. This is a potentially translated string + * that should be presented to users in the user interface. + */ properties[PROP_LABEL] = g_param_spec_string ("label", "Label", @@ -87,6 +99,11 @@ mate_mixer_switch_option_class_init (MateMixerSwitchOptionClass *klass) G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS); + /** + * MateMixerSwitchOption:icon: + * + * The XDG icon name of the switch option. + */ properties[PROP_ICON] = g_param_spec_string ("icon", "Icon", @@ -183,6 +200,15 @@ mate_mixer_switch_option_finalize (GObject *object) /** * mate_mixer_switch_option_get_name: * @option: a #MateMixerSwitchOption + * + * Gets the name of the switch option. The name serves as a unique identifier + * and in most cases it is not in a user-readable form. + * + * The returned name is guaranteed to be unique across all the switch options + * of a particular #MateMixerSwitch and may be used to get the #MateMixerSwitchOption + * using mate_mixer_switch_get_option(). + * + * Returns: the name of the switch option. */ const gchar * mate_mixer_switch_option_get_name (MateMixerSwitchOption *option) @@ -195,6 +221,11 @@ mate_mixer_switch_option_get_name (MateMixerSwitchOption *option) /** * mate_mixer_switch_option_get_label: * @option: a #MateMixerSwitchOption + * + * Gets the label of the switch option. This is a potentially translated string + * that should be presented to users in the user interface. + * + * Returns: the label of the switch option. */ const gchar * mate_mixer_switch_option_get_label (MateMixerSwitchOption *option) @@ -207,6 +238,10 @@ mate_mixer_switch_option_get_label (MateMixerSwitchOption *option) /** * mate_mixer_switch_option_get_icon: * @option: a #MateMixerSwitchOption + * + * Gets the XDG icon name of the switch option. + * + * Returns: the icon name or %NULL. */ const gchar * mate_mixer_switch_option_get_icon (MateMixerSwitchOption *option) |