Mercurial > pidgin.yaz
diff finch/libgnt/gntstyle.h @ 21253:ae330012956f
Doxygen for gnt.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Tue, 16 Oct 2007 13:06:48 +0000 |
parents | b1fa7765ca4b |
children | 6de09629f091 |
line wrap: on
line diff
--- a/finch/libgnt/gntstyle.h Tue Oct 16 11:05:59 2007 +0000 +++ b/finch/libgnt/gntstyle.h Tue Oct 16 13:06:48 2007 +0000 @@ -38,11 +38,17 @@ } GntStyle; /** - * - * @param filename + * Read configuration from a file. + * + * @param filename The filename to read configuration from. */ void gnt_style_read_configure_file(const char *filename); +/** + * Get the user-setting for a style. + * @param style The style. + * @return The user-setting, or @c NULL. + */ const char *gnt_style_get(GntStyle style); /** @@ -70,30 +76,27 @@ gboolean gnt_style_parse_bool(const char *value); /** - * - * @param style - * @param def + * Get the boolean value for a user-setting. * - * @return + * @param style The style. + * @param def The default value (i.e, the value if the user didn't define + * any value) + * + * @return The value of the setting. */ gboolean gnt_style_get_bool(GntStyle style, gboolean def); -/* This should be called only once for the each type */ /** - * - * @param type - * @param hash + * @internal */ void gnt_styles_get_keyremaps(GType type, GHashTable *hash); /** - * - * @param type - * @param klass + * @internal */ void gnt_style_read_actions(GType type, GntBindableClass *klass); -/* +/** * Read menu-accels from ~/.gntrc * * @param name The name of the window. @@ -103,15 +106,19 @@ */ gboolean gnt_style_read_menu_accels(const char *name, GHashTable *table); +/** + * @internal + * Read workspace information. + */ void gnt_style_read_workspaces(GntWM *wm); /** - * + * Initialize style settings. */ void gnt_init_styles(void); /** - * + * Uninitialize style settings. */ void gnt_uninit_styles(void);