X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fwidgets%2Fmodest-combo-box.h;h=bf464cd802672381a9f0a583d3ca34b73a9ba34a;hp=d27644c9cbc018ece9d63055cab896bc4c934da5;hb=3ddc19113ea89a4ec61a855f4856bde2143c4694;hpb=edeb005687eeda1957eee1ecbdd0c8e2ede3fff1

diff --git a/src/widgets/modest-combo-box.h b/src/widgets/modest-combo-box.h
index d27644c..bf464cd 100644
--- a/src/widgets/modest-combo-box.h
+++ b/src/widgets/modest-combo-box.h
@@ -63,7 +63,13 @@ GType        modest_combo_box_get_type    (void) G_GNUC_CONST;
 
 /**
  * modest_combo_box_new
- * @pairs: a #ModestPairList; each element should be a ptr to a #ModestPair 
+ * @pairs: a #ModestPairList; each element should be a ptr to a #ModestPair,
+ * with the first item in the pair being an opaque ID, and the second item being 
+ * a gchar* string for display. 
+ * If the ID is a string or other non fundamental type, you must make sure that 
+ * the instance remains allocated for the lifetime of this combo box.
+ * The simplest way to achieve this is to ensure that the ModestPairList exists 
+ * for as long as the combo box.
  * @cmp_id_func: a GEqualFunc to compare the ids (= the first elements of the pairs)
  * For example, if the ids are strings, you can use g_str_equal.
  *