Mercurial > pidgin
changeset 19116:992afeb1d40f
Added some docs
| author | Eric Polino <aluink@pidgin.im> |
|---|---|
| date | Wed, 27 Jun 2007 02:51:00 +0000 |
| parents | 4c26b23e7859 |
| children | 907c41608ada |
| files | finch/libgnt/gntcombobox.h |
| diffstat | 1 files changed, 24 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/finch/libgnt/gntcombobox.h Mon Jun 25 20:27:36 2007 +0000 +++ b/finch/libgnt/gntcombobox.h Wed Jun 27 02:51:00 2007 +0000 @@ -65,7 +65,8 @@ G_BEGIN_DECLS /** - * + * + * Get the GType for GntComboBox * * @return */ @@ -73,44 +74,55 @@ /** * + * Create a new GntComboBox * - * @return + * @return A new GntComboBox */ GntWidget * gnt_combo_box_new(void); /** * - * @param box - * @param key - * @param text + * Add an entry + * + * @param box The GntComboBox + * @param key The data + * @param text The text to display */ void gnt_combo_box_add_data(GntComboBox *box, gpointer key, const char *text); /** + * + * Remove an entry * - * @param box - * @param key + * @param box The GntComboBox + * @param key The data to be removed */ void gnt_combo_box_remove(GntComboBox *box, gpointer key); /** * - * @param box + * Remove all entries + * + * @param box The GntComboBox */ void gnt_combo_box_remove_all(GntComboBox *box); /** * - * @param box + * Get the data that is currently selected * - * @return + * @param box The GntComboBox + * + * @return The data of the currently selected entry */ gpointer gnt_combo_box_get_selected_data(GntComboBox *box); /** * - * @param box - * @param key + * Set the current selection to a specific entry + * + * @param box The GntComboBox + * @param key The data to be set to */ void gnt_combo_box_set_selected(GntComboBox *box, gpointer key);