From 864b830e2e7b85d8763142326f84bc7b38acde97 Mon Sep 17 00:00:00 2001 From: William Pettersson Date: Thu, 20 Jul 2023 09:14:32 +0100 Subject: Document the status property a bit more clearly. Details of what each property means are taken from lines ~144-146 of app-indicator.h (search for @APP_INDICATOR_STATUS_PASSIVE). --- src/app-indicator.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/app-indicator.c b/src/app-indicator.c index ebedc65..87e66ed 100644 --- a/src/app-indicator.c +++ b/src/app-indicator.c @@ -326,14 +326,16 @@ app_indicator_class_init (AppIndicatorClass *klass) /** * AppIndicator:status: * - * Whether the indicator is shown or requests attention. Defaults to - * 'Passive'. + * Whether the indicator is shown or requests attention. Can be one of + * 'Passive' (the indicator should not be shown), 'Active' (the indicator + * should be shown in its default state), and 'Attention' (the indicator + * should now show it's attention icon). Defaults to 'Passive'. */ g_object_class_install_property (object_class, PROP_STATUS, g_param_spec_string (PROP_STATUS_S, "Indicator Status", - "Whether the indicator is shown or requests attention. Defaults to 'Passive'.", + "Whether the indicator is shown or requests attention. Can be one of 'Passive' (the indicator should not be shown), 'Active' (the indicator should be shown in its default state), and 'Attention' (the indicator should now show it's attention icon). Defaults to 'Passive'.", NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); -- cgit v1.2.3