Document the HildonNoteType enumeration

* hildon/hildon-note.h: Document the HildonNoteType enumeration.

Fixes: MB#4556 (HildonNoteType is undocumented)

diff --git a/ChangeLog b/ChangeLog
index 2425076..a9928ed 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2009-06-16  Claudio Saavedra  <csaavedra@igalia.com>
+
+       * hildon/hildon-note.h: Document the HildonNoteType enumeration.
+
+       Fixes: MB#4556 (HildonNoteType is undocumented)
+
 2009-06-15  Alberto Garcia  <agarcia@igalia.com>
 
        * hildon/hildon-picker-button.c:

diff --git a/hildon/hildon-note.h b/hildon/hildon-note.h
index d67f6c6..6e8f67f 100644 (file)
--- a/hildon/hildon-note.h
+++ b/hildon/hildon-note.h
@@ -103,6 +103,19 @@ hildon_note_set_button_texts                    (HildonNote *note,
                                                  const gchar *text_ok,
                                                  const gchar *text_cancel);
 
+/**
+ * HildonNoteType:
+ * @HILDON_NOTE_TYPE_CONFIRMATION: Standard confirmation note with 'Yes'
+ * and 'No' buttons.
+ * @HILDON_NOTE_TYPE_CONFIRMATION_BUTTON: Confirmation note with
+ * custom buttons.
+ * @HILDON_NOTE_TYPE_INFORMATION: Information note with an 'OK' button.
+ * @HILDON_NOTE_TYPE_INFORMATION_THEME: Deprecated information note with a themed
+ * icon. Equivalent to %HILDON_NOTE_TYPE_INFORMATION.
+ * @HILDON_NOTE_TYPE_PROGRESSBAR: Note with a #GtkProgressBar and an 'OK' button.
+ *
+ * Type of a #HildonNote, defining its behavior, contents, and theming.
+ */
 typedef enum
 {
     HILDON_NOTE_TYPE_CONFIRMATION = 0,