im.pidgin.pidgin: 240095fc3a12eafe8418f57362c4b2a88da143c1
markdoliner at pidgin.im
markdoliner at pidgin.im
Wed Nov 7 04:20:41 EST 2007
-----------------------------------------------------------------
Revision: 240095fc3a12eafe8418f57362c4b2a88da143c1
Ancestor: ae7d6a059cb6a63da97a3af79360e507a2c9c944
Author: markdoliner at pidgin.im
Date: 2007-11-07T09:19:25
Branch: im.pidgin.pidgin
Modified files:
finch/libgnt/gnt.h finch/libgnt/gntbindable.h
finch/libgnt/gntfilesel.h finch/libgnt/gntkeys.h
finch/libgnt/gntlabel.h finch/libgnt/gntline.h
finch/libgnt/gntmenu.h finch/libgnt/gntmenuitem.h
finch/libgnt/gntmenuitemcheck.h finch/libgnt/gntstyle.h
finch/libgnt/gnttextview.h finch/libgnt/gntutils.h
finch/libgnt/gntwidget.h finch/libgnt/gntwindow.h
finch/libgnt/gntwm.h
ChangeLog:
Get rid of some doxygen warnings by removing undocumented @params
-------------- next part --------------
============================================================
--- finch/libgnt/gnt.h 06b3caa65be64f8ffb268548d25588e444e6f781
+++ finch/libgnt/gnt.h b205db94471b69d3a9a2fa55cf85bb832af1d1e2
@@ -46,18 +46,18 @@
#endif
/**
- *
+ *
*/
void gnt_init(void);
/**
- *
+ *
*/
void gnt_main(void);
/**
- *
*
+ *
* @return
*/
gboolean gnt_ascii_only(void);
@@ -66,103 +66,87 @@ gboolean gnt_ascii_only(void);
* 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 the present.
+ * @param window The window to 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);
============================================================
--- finch/libgnt/gntbindable.h 9e7af7ad9534107c652956dcfc02af39efb20f84
+++ finch/libgnt/gntbindable.h b541eb2c146764bee3383801228e8caf78f49d87
@@ -160,9 +160,9 @@ gboolean gnt_bindable_perform_action_nam
/**
* Returns a GntTree populated with "key" -> "binding" for the widget.
- *
- * @param widget The object to list the bindings for.
*
+ * @param bind The object to list the bindings for.
+ *
* @return The GntTree.
*/
GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
@@ -170,9 +170,9 @@ GntBindable * gnt_bindable_bindings_view
/**
* 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
*/
============================================================
--- finch/libgnt/gntfilesel.h 75f832581ce55551a3e0fc7ba48f454dc39147a9
+++ finch/libgnt/gntfilesel.h 1ed7559af33b0503f99f01019a08f2905b86ae05
@@ -98,62 +98,51 @@ G_BEGIN_DECLS
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
*/
char * gnt_file_sel_get_selected_file(GntFileSel *sel);
@@ -161,49 +150,37 @@ char * gnt_file_sel_get_selected_file(Gn
/* 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
*/
GntFile* gnt_file_new_dir(const char *name);
============================================================
--- finch/libgnt/gntkeys.h 8f016e6005588633ad4c165e3676d584c8eb0874
+++ finch/libgnt/gntkeys.h 725f97952887b45506d4adb7267e327c26ae6e2a
@@ -107,13 +107,12 @@ extern char *gnt_key_cright;
* This will do stuff with the terminal settings and stuff.
*/
/**
- *
+ *
*/
void gnt_init_keys(void);
/**
- *
- * @param text
+ *
*/
void gnt_keys_refine(char *text);
@@ -121,26 +120,23 @@ const char *gnt_key_lookup(const char *k
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 <term.h>.
+/* A lot of commonly used variable names are defined in <term.h>.
* #undef them to make life easier for everyone. */
#undef columns
============================================================
--- finch/libgnt/gntlabel.h 73047ef6b9da8425bf5e1c3345c1b9c7e367fb2b
+++ finch/libgnt/gntlabel.h 5372e99a95ca1e0e4c69e8aab0f0e230ce3c5a92
@@ -67,33 +67,28 @@ G_BEGIN_DECLS
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);
============================================================
--- finch/libgnt/gntline.h 9c2fd44593c25f2df83b6d44ea1c89bd01ebcd60
+++ finch/libgnt/gntline.h 9c64b5089a136ca6e5c0fe3def5a32bd9a500397
@@ -67,8 +67,8 @@ G_BEGIN_DECLS
G_BEGIN_DECLS
/**
- *
*
+ *
* @return
*/
GType gnt_line_get_gtype(void);
@@ -77,9 +77,8 @@ GType gnt_line_get_gtype(void);
#define gnt_vline_new() gnt_line_new(TRUE)
/**
- *
- * @param vertical
*
+ *
* @return
*/
GntWidget * gnt_line_new(gboolean vertical);
============================================================
--- finch/libgnt/gntmenu.h 1c2f3274f300a2e3a833b6ef1c737dadda8ee0ce
+++ finch/libgnt/gntmenu.h 31225391e07f0f63b68655a5668ddb0fa57794fc
@@ -63,7 +63,7 @@ struct _GntMenu
{
GntTree parent;
GntMenuType type;
-
+
GList *list;
int selected;
@@ -86,24 +86,20 @@ G_BEGIN_DECLS
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);
============================================================
--- finch/libgnt/gntmenuitem.h 47117283f62ee0919dba3e083e622a43bc68f5c0
+++ finch/libgnt/gntmenuitem.h 2ede622be69fda48b817996e19658ceef0f91c21
@@ -86,32 +86,26 @@ G_BEGIN_DECLS
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);
============================================================
--- finch/libgnt/gntmenuitemcheck.h 65b7bdc04f469ab96edeb89f05220d31d1e95d62
+++ finch/libgnt/gntmenuitemcheck.h 6afc43b5fd48359f7f5b4fc7cb36a0a4f1dac065
@@ -66,32 +66,28 @@ G_BEGIN_DECLS
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);
============================================================
--- finch/libgnt/gntstyle.h b17e77991c763ee5d9556c000cf673a0d31b5a1f
+++ finch/libgnt/gntstyle.h 3565b1847f2a9a60afee0a39b43c4b523237da3a
@@ -38,8 +38,7 @@ typedef enum
} GntStyle;
/**
- *
- * @param filename
+ *
*/
void gnt_style_read_configure_file(const char *filename);
@@ -70,38 +69,32 @@ gboolean gnt_style_parse_bool(const char
gboolean gnt_style_parse_bool(const char *value);
/**
- *
- * @param style
- * @param def
*
+ *
* @return
*/
gboolean gnt_style_get_bool(GntStyle style, gboolean def);
/* 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);
============================================================
--- finch/libgnt/gnttextview.h 6454178a30a3da4da742848557432931439a948f
+++ finch/libgnt/gnttextview.h 13feb22ec71f8231afd51434d91c7b77e669184a
@@ -88,8 +88,8 @@ G_BEGIN_DECLS
G_BEGIN_DECLS
/**
- *
*
+ *
* @return
*/
GType gnt_text_view_get_gtype(void);
@@ -97,105 +97,81 @@ GType gnt_text_view_get_gtype(void);
/* XXX: For now, don't set a textview to have any border.
* If you want borders real bad, put it in a box. */
/**
- *
*
+ *
* @return
*/
GntWidget * gnt_text_view_new(void);
/* 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
*/
int gnt_text_view_get_lines_above(GntTextView *view);
/* 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);
============================================================
--- finch/libgnt/gntutils.h 04d122a1b3550dc1e9e4acda1ee6e7297aa410e8
+++ finch/libgnt/gntutils.h 551b064463704231bd548dfd80ba020b631648d1
@@ -147,8 +147,8 @@ gboolean gnt_util_parse_xhtml_to_textvie
/**
* Make some keypress activate a button when some key is pressed with 'wid' in focus.
*
- * @param widget The widget
- * @param key The key to trigger the button
+ * @param wid The widget
+ * @param text The key to trigger the button
* @param button The button to trigger
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
============================================================
--- finch/libgnt/gntwidget.h aab8d841b58b295bd3f9df38c07bc120f16f1b8f
+++ finch/libgnt/gntwidget.h 4817d590c9f4ca4743b253ae07fad68c495275bb
@@ -140,135 +140,99 @@ G_BEGIN_DECLS
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);
@@ -277,29 +241,23 @@ const char *gnt_widget_get_name(GntWidge
/* 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
*/
gboolean gnt_widget_has_shadow(GntWidget *widget);
============================================================
--- finch/libgnt/gntwindow.h 333e0971fbfd4ab3532308372d163499a02f8d08
+++ finch/libgnt/gntwindow.h d42c9767329a43c0614b8f172660679229060c25
@@ -67,8 +67,8 @@ G_BEGIN_DECLS
G_BEGIN_DECLS
/**
- *
*
+ *
* @return
*/
GType gnt_window_get_gtype(void);
@@ -77,25 +77,21 @@ GType gnt_window_get_gtype(void);
#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);
============================================================
--- finch/libgnt/gntwm.h 0ab1e279541f0f76ce7a1dbde6bd2964184348f1
+++ finch/libgnt/gntwm.h 1def82b84a99a60d828cac7e17ce07910ecae2e1
@@ -113,7 +113,7 @@ struct _GntWM
* whether to give focus to a new window.
*/
gboolean event_stack;
-
+
GntKeyPressMode mode;
GHashTable *positions;
@@ -184,8 +184,8 @@ G_BEGIN_DECLS
G_BEGIN_DECLS
/**
- *
*
+ *
* @return
*/
GType gnt_wm_get_gtype(void);
@@ -200,91 +200,64 @@ GntWS *gnt_wm_widget_find_workspace(GntW
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
*/
time_t gnt_wm_get_idle_time(void);
More information about the Commits
mailing list