N#21063 hildon_note_new_confirmation_add_buttons has misleading docs * hildon-widgets...

diff --git a/ChangeLog b/ChangeLog
index 5fad385..59fc07e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2006-01-11  Luc Pionchon  <luc.pionchon@nokia.com>
 
+        N#21063 hildon_note_new_confirmation_add_buttons has misleading docs
+       * hildon-widgets/hildon-note.c: 
+       (hildon_note_new_confirmation_add_buttons): updated doc
+       (hildon_note_set_button_texts): likewise.
+
+2006-01-11  Luc Pionchon  <luc.pionchon@nokia.com>
+
        N#21884 Cannot select read-only by using the center of the scroll key
        * hildon-widgets/hildon-file-details-dialog.c
        (hildon_file_details_dialog_init): Removed dialog default response.

diff --git a/debian/changelog b/debian/changelog
index 447dc0a..18eba11 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,5 +1,6 @@
 hildon-libs (0.10.1-1) unstable; urgency=low
 
+  * N#21063 hildon_note_new_confirmation_add_buttons has misleading docs
   * N#21884 Cannot select read-only by using the center of the scroll key
   * N#8094 5-bit color selector: wrong margins and pixel measurements
     M#59   HildonColorSelector needs more space

diff --git a/hildon-widgets/hildon-note.c b/hildon-widgets/hildon-note.c
index d6f8b25..78ee768 100644 (file)
--- a/hildon-widgets/hildon-note.c
+++ b/hildon-widgets/hildon-note.c
@@ -715,10 +715,14 @@ hildon_note_create_form(GtkDialog * dialog, GtkWidget * item,
  *   In GTK the X window ID can be checked with
  *   GDK_WINDOW_XID(GTK_WIDGET(parent)->window).
  * @description: The message to confirm.
- * @Varargs: Arguments pairs for new buttons(label and return value)
+ * @Varargs: Arguments pairs for new buttons(label and return value). 
+ *   Terminate the list with %NULL value.
  * 
- * Create a new confirmation note. Confirmation note has a text, 
- * two buttons and infinite number of additional buttons and an icon.
+ * Create a new confirmation note with custom buttons. Confirmation
+ * note has a text and any number of buttons. It's important to note
+ * that even though the name of the function might suggest, the
+ * default ok/cancel buttons are not appended but you have to provide
+ * all of the buttons.
  *
  * Return value: A #GtkWidget pointer of the note.
  */
@@ -1036,13 +1040,14 @@ void hildon_note_set_button_text(HildonNote * note, const gchar * text)
 /**
  * hildon_note_set_button_texts:
  * @note: A #HildonNote
- * @text: Sets the button text and if there is two buttons in dialog, 
- *   the button texts will be <textOk>, <textCancel>.  
+ * @textOk: the new text of the default OK button.
+ * @textCancel: the new text of the default cancel button. 
  *
  * Sets the button texts to be used by this hildon_note widget.
  */
-void hildon_note_set_button_texts(HildonNote * note, const gchar * textOk,
-                                const gchar * textCancel)
+void hildon_note_set_button_texts(HildonNote * note,
+                                  const gchar * textOk,
+                                  const gchar * textCancel)
 {
     HildonNotePrivate *priv;