diff options
| author | Ted Gould <ted@gould.cx> | 2009-12-08 15:45:17 -0600 |
|---|---|---|
| committer | Ted Gould <ted@gould.cx> | 2009-12-08 15:45:17 -0600 |
| commit | a29bb3d355c7a6cd97241ca3d7decb61545c0ece (patch) | |
| tree | 52517ba82321047aaac9cacd4f5da8d421fbb70b /src | |
| parent | b8e1a7185cbdc978f1a637c719ef4b8a3faec94a (diff) | |
| download | libayatana-appindicator-a29bb3d355c7a6cd97241ca3d7decb61545c0ece.tar.gz libayatana-appindicator-a29bb3d355c7a6cd97241ca3d7decb61545c0ece.tar.bz2 libayatana-appindicator-a29bb3d355c7a6cd97241ca3d7decb61545c0ece.zip | |
Adding in some section documentation.
Diffstat (limited to 'src')
| -rw-r--r-- | src/libappindicator/app-indicator.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/libappindicator/app-indicator.h b/src/libappindicator/app-indicator.h index 3a46405..e966a49 100644 --- a/src/libappindicator/app-indicator.h +++ b/src/libappindicator/app-indicator.h @@ -222,4 +222,21 @@ const gchar * app_indicator_get_attention_icon (AppIndicator * G_END_DECLS +/** + SECTION:app-indicator + @short_description: An object to put application information + into the panel. + @stability: Unstable + @include: libappindicator/app-indicator.h + + An application indicator is a way for an application to put + a menu into the panel on the user's screen. This allows the + user to interact with the application even though it might + not be visible to the user at the time. In most cases this + is not a good solution as there are other ways to inform the + user. It should only be use if persistence is a desired + feature for the user (not for your marketing purpose of + having your logo in the panel). +*/ + #endif |