# HG changeset patch # User Sadrul Habib Chowdhury # Date 1194443388 0 # Node ID 45e550db32ab0c6bc726184e65d54a55781bd69f # Parent bddf964880cf5bfd5b6d2ca1040518703892d953# Parent 7c80ba584fb0bb07ae383df9f88d255048e63fb1 merge of '656ddea68cc0419829183e2676970ed21efb838f' and '9825a5529451f2000418ac3fb9c586502380a2c6' diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gnt.h --- a/finch/libgnt/gnt.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gnt.h Wed Nov 07 13:49:48 2007 +0000 @@ -46,17 +46,17 @@ #endif /** - * + * */ void gnt_init(void); /** - * + * */ void gnt_main(void); /** - * + * * * @return */ @@ -66,87 +66,103 @@ * Present a window. If the event was triggered because of user interaction, * the window is moved to the foreground. Otherwise, the Urgent hint is set. * - * @param window The window to present. + * @param window The window the present. * * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_window_present(GntWidget *window); - /** - * + * + * @param widget */ void gnt_screen_occupy(GntWidget *widget); /** - * + * + * @param widget */ void gnt_screen_release(GntWidget *widget); /** - * + * + * @param widget */ void gnt_screen_update(GntWidget *widget); /** - * + * + * @param widget + * @param width + * @param height */ void gnt_screen_resize_widget(GntWidget *widget, int width, int height); /** - * + * + * @param widget + * @param x + * @param y */ void gnt_screen_move_widget(GntWidget *widget, int x, int y); /** - * + * + * @param widget + * @param text */ void gnt_screen_rename_widget(GntWidget *widget, const char *text); /** - * + * + * @param widget * * @return */ gboolean gnt_widget_has_focus(GntWidget *widget); /** - * + * + * @param widget */ void gnt_widget_set_urgent(GntWidget *widget); /** - * + * + * @param label + * @param callback */ void gnt_register_action(const char *label, void (*callback)()); /** - * + * + * @param menu * * @return */ gboolean gnt_screen_menu_show(gpointer menu); /** - * + * */ void gnt_quit(void); /** - * + * * * @return */ GntClipboard * gnt_get_clipboard(void); /** - * + * * * @return */ gchar * gnt_get_clipboard_string(void); /** - * + * + * @param string */ void gnt_set_clipboard_string(gchar *string); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntbindable.h --- a/finch/libgnt/gntbindable.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntbindable.h Wed Nov 07 13:49:48 2007 +0000 @@ -160,8 +160,8 @@ /** * Returns a GntTree populated with "key" -> "binding" for the widget. - * - * @param bind The object to list the bindings for. + * + * @param widget The object to list the bindings for. * * @return The GntTree. */ @@ -170,9 +170,9 @@ /** * Builds a window that list the key bindings for a GntBindable object. * From this window a user can select a listing to rebind a new key for the given action. - * + * * @param bindable The object to list the bindings for. - * + * * @return @c TRUE */ diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntfilesel.h --- a/finch/libgnt/gntfilesel.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntfilesel.h Wed Nov 07 13:49:48 2007 +0000 @@ -98,50 +98,61 @@ G_BEGIN_DECLS /** - * + * * * @return */ GType gnt_file_sel_get_gtype(void); /** - * + * * * @return */ GntWidget * gnt_file_sel_new(void); /** + * + * @param sel + * @param path * * @return */ gboolean gnt_file_sel_set_current_location(GntFileSel *sel, const char *path); /** - * + * + * @param sel + * @param dirs */ void gnt_file_sel_set_dirs_only(GntFileSel *sel, gboolean dirs); /** + * + * @param sel * * @return */ gboolean gnt_file_sel_get_dirs_only(GntFileSel *sel); /** - * + * + * @param sel + * @param must */ void gnt_file_sel_set_must_exist(GntFileSel *sel, gboolean must); /** - * + * + * @param sel * * @return */ gboolean gnt_file_sel_get_must_exist(GntFileSel *sel); /** - * + * + * @param sel * * @return */ @@ -150,36 +161,48 @@ /* The returned value should be free'd */ /** - * + * + * @param sel * * @return */ GList * gnt_file_sel_get_selected_multi_files(GntFileSel *sel); /** - * + * + * @param sel + * @param set */ void gnt_file_sel_set_multi_select(GntFileSel *sel, gboolean set); /** - * + * + * @param sel + * @param suggest */ void gnt_file_sel_set_suggested_filename(GntFileSel *sel, const char *suggest); /** - * + * + * @param sel + * @param path + * @param files + * @param error) */ void gnt_file_sel_set_read_fn(GntFileSel *sel, gboolean (*read_fn)(const char *path, GList **files, GError **error)); /** - * + * + * @param name + * @param size * * @return */ GntFile* gnt_file_new(const char *name, unsigned long size); /** - * + * + * @param name * * @return */ diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntkeys.h --- a/finch/libgnt/gntkeys.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntkeys.h Wed Nov 07 13:49:48 2007 +0000 @@ -107,12 +107,13 @@ * This will do stuff with the terminal settings and stuff. */ /** - * + * */ void gnt_init_keys(void); /** - * + * + * @param text */ void gnt_keys_refine(char *text); @@ -120,23 +121,26 @@ const char *gnt_key_lookup(const char *key); /** - * + * + * @param path */ void gnt_keys_add_combination(const char *path); /** - * + * + * @param path */ void gnt_keys_del_combination(const char *path); /** - * + * + * @param path * * @return */ int gnt_keys_find_combination(const char *path); -/* A lot of commonly used variable names are defined in . +/* A lot of commonly used variable names are defined in . * #undef them to make life easier for everyone. */ #undef columns diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntlabel.h --- a/finch/libgnt/gntlabel.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntlabel.h Wed Nov 07 13:49:48 2007 +0000 @@ -67,28 +67,33 @@ G_BEGIN_DECLS /** - * + * * * @return */ GType gnt_label_get_gtype(void); /** - * + * + * @param text * * @return */ GntWidget * gnt_label_new(const char *text); /** - * + * + * @param text + * @param flags * * @return */ GntWidget * gnt_label_new_with_format(const char *text, GntTextFormatFlags flags); /** - * + * + * @param label + * @param text */ void gnt_label_set_text(GntLabel *label, const char *text); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntline.h --- a/finch/libgnt/gntline.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntline.h Wed Nov 07 13:49:48 2007 +0000 @@ -67,7 +67,7 @@ G_BEGIN_DECLS /** - * + * * * @return */ @@ -77,7 +77,8 @@ #define gnt_vline_new() gnt_line_new(TRUE) /** - * + * + * @param vertical * * @return */ diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntmenu.h --- a/finch/libgnt/gntmenu.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntmenu.h Wed Nov 07 13:49:48 2007 +0000 @@ -63,7 +63,7 @@ { GntTree parent; GntMenuType type; - + GList *list; int selected; @@ -86,20 +86,24 @@ G_BEGIN_DECLS /** - * + * * * @return */ GType gnt_menu_get_gtype(void); /** + * + * @param type * * @return */ GntWidget * gnt_menu_new(GntMenuType type); /** - * + * + * @param menu + * @param item */ void gnt_menu_add_item(GntMenu *menu, GntMenuItem *item); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntmenuitem.h --- a/finch/libgnt/gntmenuitem.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntmenuitem.h Wed Nov 07 13:49:48 2007 +0000 @@ -86,26 +86,32 @@ G_BEGIN_DECLS /** - * + * * * @return */ GType gnt_menuitem_get_gtype(void); /** - * + * + * @param text * * @return */ GntMenuItem * gnt_menuitem_new(const char *text); /** - * + * + * @param item + * @param callback + * @param data */ void gnt_menuitem_set_callback(GntMenuItem *item, GntMenuItemCallback callback, gpointer data); /** - * + * + * @param item + * @param menu */ void gnt_menuitem_set_submenu(GntMenuItem *item, GntMenu *menu); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntmenuitemcheck.h --- a/finch/libgnt/gntmenuitemcheck.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntmenuitemcheck.h Wed Nov 07 13:49:48 2007 +0000 @@ -66,28 +66,32 @@ G_BEGIN_DECLS /** - * + * * * @return */ GType gnt_menuitem_check_get_gtype(void); /** - * + * + * @param text * * @return */ GntMenuItem * gnt_menuitem_check_new(const char *text); /** - * + * + * @param item * * @return */ gboolean gnt_menuitem_check_get_checked(GntMenuItemCheck *item); /** - * + * + * @param item + * @param set */ void gnt_menuitem_check_set_checked(GntMenuItemCheck *item, gboolean set); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntstyle.h --- a/finch/libgnt/gntstyle.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntstyle.h Wed Nov 07 13:49:48 2007 +0000 @@ -38,7 +38,8 @@ } GntStyle; /** - * + * + * @param filename */ void gnt_style_read_configure_file(const char *filename); @@ -69,7 +70,9 @@ gboolean gnt_style_parse_bool(const char *value); /** - * + * + * @param style + * @param def * * @return */ @@ -77,24 +80,28 @@ /* This should be called only once for the each type */ /** - * + * + * @param type + * @param hash */ void gnt_styles_get_keyremaps(GType type, GHashTable *hash); /** - * + * + * @param type + * @param klass */ void gnt_style_read_actions(GType type, GntBindableClass *klass); void gnt_style_read_workspaces(GntWM *wm); /** - * + * */ void gnt_init_styles(void); /** - * + * */ void gnt_uninit_styles(void); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gnttextview.h --- a/finch/libgnt/gnttextview.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gnttextview.h Wed Nov 07 13:49:48 2007 +0000 @@ -88,7 +88,7 @@ G_BEGIN_DECLS /** - * + * * * @return */ @@ -97,7 +97,7 @@ /* XXX: For now, don't set a textview to have any border. * If you want borders real bad, put it in a box. */ /** - * + * * * @return */ @@ -105,48 +105,62 @@ /* scroll > 0 means scroll up, < 0 means scroll down, == 0 means scroll to the end */ /** - * + * + * @param view + * @param scroll */ void gnt_text_view_scroll(GntTextView *view, int scroll); /** - * + * + * @param view + * @param text + * @param flags */ void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags); /** - * + * + * @param view + * @param text + * @param flags + * @param tag */ void gnt_text_view_append_text_with_tag(GntTextView *view, const char *text, GntTextFormatFlags flags, const char *tag); /* Move the cursor to the beginning of the next line and resets text-attributes. * It first completes the current line with the current text-attributes. */ /** - * + * + * @param view */ void gnt_text_view_next_line(GntTextView *view); /** - * + * + * @param flags * * @return */ chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags); /** - * + * + * @param view */ void gnt_text_view_clear(GntTextView *view); /** - * + * + * @param view * * @return */ int gnt_text_view_get_lines_below(GntTextView *view); /** - * + * + * @param view * * @return */ @@ -154,24 +168,34 @@ /* If text is NULL, then the tag is removed. */ /** - * + * + * @param view + * @param name + * @param text + * @param all * * @return */ int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all); /** - * + * + * @param view + * @param widget */ void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget); /** - * + * + * @param view + * @param widget */ void gnt_text_view_attach_pager_widget(GntTextView *view, GntWidget *pager); /** - * + * + * @param view + * @param widget */ void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *pager); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntutils.h --- a/finch/libgnt/gntutils.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntutils.h Wed Nov 07 13:49:48 2007 +0000 @@ -147,8 +147,8 @@ /** * Make some keypress activate a button when some key is pressed with 'wid' in focus. * - * @param wid The widget - * @param text The key to trigger the button + * @param widget The widget + * @param key The key to trigger the button * @param button The button to trigger * * @since 2.0.0 (gnt), 2.1.0 (pidgin) diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntwidget.h --- a/finch/libgnt/gntwidget.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntwidget.h Wed Nov 07 13:49:48 2007 +0000 @@ -140,99 +140,135 @@ G_BEGIN_DECLS /** - * + * * * @return */ GType gnt_widget_get_gtype(void); /** - * + * + * @param widget */ void gnt_widget_destroy(GntWidget *widget); /** - * + * + * @param widget */ void gnt_widget_show(GntWidget *widget); /** - * + * + * @param widget */ void gnt_widget_draw(GntWidget *widget); /** - * + * + * @param widget + * @param x + * @param y + * @param width + * @param height */ void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height); /** - * + * + * @param widget */ void gnt_widget_hide(GntWidget *widget); /** - * + * + * @param widget + * @param x + * @param y */ void gnt_widget_get_position(GntWidget *widget, int *x, int *y); /** - * + * + * @param widget + * @param x + * @param y */ void gnt_widget_set_position(GntWidget *widget, int x, int y); /** - * + * + * @param widget */ void gnt_widget_size_request(GntWidget *widget); /** - * + * + * @param widget + * @param width + * @param height */ void gnt_widget_get_size(GntWidget *widget, int *width, int *height); /** - * + * + * @param widget + * @param width + * @param height * * @return */ gboolean gnt_widget_set_size(GntWidget *widget, int width, int height); /** - * + * + * @param widget + * @param width + * @param height * * @return */ gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height); /** - * + * + * @param widget + * @param keys * * @return */ gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys); /** - * + * + * @param widget + * @param event + * @param x + * @param y * * @return */ gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y); /** - * + * + * @param widget + * @param set * * @return */ gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set); /** - * + * + * @param widget */ void gnt_widget_activate(GntWidget *widget); /** - * + * + * @param widget + * @param name */ void gnt_widget_set_name(GntWidget *widget, const char *name); @@ -241,22 +277,28 @@ /* Widget-subclasses should call this from the draw-callback. * Applications should just call gnt_widget_draw instead of this. */ /** - * + * + * @param widget */ void gnt_widget_queue_update(GntWidget *widget); /** - * + * + * @param widget + * @param set */ void gnt_widget_set_take_focus(GntWidget *widget, gboolean set); /** - * + * + * @param widget + * @param set */ void gnt_widget_set_visible(GntWidget *widget, gboolean set); /** - * + * + * @param widget * * @return */ diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntwindow.h --- a/finch/libgnt/gntwindow.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntwindow.h Wed Nov 07 13:49:48 2007 +0000 @@ -67,7 +67,7 @@ G_BEGIN_DECLS /** - * + * * * @return */ @@ -77,21 +77,25 @@ #define gnt_hwindow_new(homo) gnt_window_box_new(homo, FALSE) /** - * + * * * @return */ GntWidget * gnt_window_new(void); /** - * + * + * @param homo + * @param vert * * @return */ GntWidget * gnt_window_box_new(gboolean homo, gboolean vert); /** - * + * + * @param window + * @param menu */ void gnt_window_set_menu(GntWindow *window, GntMenu *menu); diff -r 7c80ba584fb0 -r 45e550db32ab finch/libgnt/gntwm.h --- a/finch/libgnt/gntwm.h Wed Nov 07 10:51:21 2007 +0000 +++ b/finch/libgnt/gntwm.h Wed Nov 07 13:49:48 2007 +0000 @@ -113,7 +113,7 @@ * whether to give focus to a new window. */ gboolean event_stack; - + GntKeyPressMode mode; GHashTable *positions; @@ -184,7 +184,7 @@ G_BEGIN_DECLS /** - * + * * * @return */ @@ -200,63 +200,90 @@ GntWS *gnt_wm_widget_find_workspace(GntWM *wm, GntWidget *widget); /** - * + * + * @param wm + * @param widget */ void gnt_wm_new_window(GntWM *wm, GntWidget *widget); /** - * + * + * @param wm + * @param widget */ void gnt_wm_window_decorate(GntWM *wm, GntWidget *widget); /** - * + * + * @param wm + * @param widget */ void gnt_wm_window_close(GntWM *wm, GntWidget *widget); /** - * + * + * @param wm + * @param string * * @return */ gboolean gnt_wm_process_input(GntWM *wm, const char *string); /** - * + * + * @param wm + * @param event + * @param x + * @param y + * @param widget * * @return */ gboolean gnt_wm_process_click(GntWM *wm, GntMouseEvent event, int x, int y, GntWidget *widget); /** - * + * + * @param wm + * @param widget + * @param width + * @param height */ void gnt_wm_resize_window(GntWM *wm, GntWidget *widget, int width, int height); /** - * + * + * @param wm + * @param widget + * @param x + * @param y */ void gnt_wm_move_window(GntWM *wm, GntWidget *widget, int x, int y); /** - * + * + * @param wm + * @param widget */ void gnt_wm_update_window(GntWM *wm, GntWidget *widget); /** - * + * + * @param wm + * @param widget */ void gnt_wm_raise_window(GntWM *wm, GntWidget *widget); /** - * + * + * @param wm + * @param set */ void gnt_wm_set_event_stack(GntWM *wm, gboolean set); void gnt_wm_copy_win(GntWidget *widget, GntNode *node); /** - * + * * * @return */