Minor changes for gtk-doc * hildon-note.c * hildon-weekday-picker.h * hildon-name...
authorLuc Pionchon <luc.pionchon@nokia.com>
Sun, 16 Apr 2006 23:50:03 +0000 (23:50 +0000)
committerLuc Pionchon <luc.pionchon@nokia.com>
Sun, 16 Apr 2006 23:50:03 +0000 (23:50 +0000)
12 files changed:
ChangeLog
hildon-widgets/gtk-infoprint.c
hildon-widgets/hildon-app.c
hildon-widgets/hildon-banner.c
hildon-widgets/hildon-calendar-popup.h
hildon-widgets/hildon-date-editor.h
hildon-widgets/hildon-name-password-dialog.c
hildon-widgets/hildon-note.c
hildon-widgets/hildon-range-editor.h
hildon-widgets/hildon-time-editor.c
hildon-widgets/hildon-volumebar-range.h
hildon-widgets/hildon-weekday-picker.h

index 2defb9d..6cc976d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,19 @@
+2006-04-17  Luc Pionchon  <luc.pionchon@nokia.com>
+
+       Minor changes for gtk-doc
+       * hildon-note.c
+       * hildon-weekday-picker.h
+       * hildon-name-password-dialog.c
+       * hildon-calendar-popup.h
+       * hildon-range-editor.h
+       * hildon-volumebar-range.h
+       * hildon-banner.c
+       * hildon-app.c
+       * hildon-time-editor.c
+       * gtk-infoprint.c
+       * hildon-date-editor.h
+
+
 2006-04-16  Luc Pionchon  <luc.pionchon@nokia.com>
 
        * hildon-widgets/hildon-time-editor.c
index 14939b5..fe88778 100644 (file)
  *
  */
 
+/**
+ * SECTION:gtk-infoprint
+ * @short_description: deprecated widget. Use #HildonBanner instead
+ *
+ * This widget is deprectaed. Use #HildonBanner instead
+ */
+
 #include "gtk-infoprint.h"
 #include "hildon-banner.h"
 
@@ -61,8 +68,7 @@ static GtkWidget *find_banner_for_parent(GtkWindow *parent)
  * Normally you should use your application window
  * or dialog as a transient parent and avoid passing %NULL.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_information instead.
+ * Deprecated: Use #hildon_banner_show_information instead.
  */
 void gtk_infoprint(GtkWindow * parent, const gchar * text)
 {
@@ -83,8 +89,7 @@ void gtk_infoprint(GtkWindow * parent, const gchar * text)
  * Normally you should use your application window
  * or dialog as a transient parent and avoid passing %NULL.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_information instead.
+ * Deprecated: Use #hildon_banner_show_information instead.
  */
 void
 gtk_infoprint_with_icon_stock(GtkWindow * parent,
@@ -107,8 +112,7 @@ gtk_infoprint_with_icon_stock(GtkWindow * parent,
  * Normally you should use your application window
  * or dialog as a transient parent and avoid passing %NULL.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_information instead.
+ * Deprecated: Use #hildon_banner_show_information instead.
  */
 void
 gtk_infoprint_with_icon_name(GtkWindow * parent,
@@ -130,8 +134,7 @@ gtk_infoprint_with_icon_name(GtkWindow * parent,
  * This version of infoprint allow you to make printf-like formatting
  * easily.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_information instead.
+ * Deprecated: Use #hildon_banner_show_information instead.
  */
 void gtk_infoprintf(GtkWindow * parent, const gchar * format, ...)
 {
@@ -153,8 +156,9 @@ void gtk_infoprintf(GtkWindow * parent, const gchar * format, ...)
  * Will disable wrapping for the next shown infoprint. This only
  * affects next infoprint shown in this application.
  *
- * This function is deprecated and should not be used.
  * Currently it does nothing.
+ *
+ * Deprecated: 
  */
 void gtk_infoprint_temporarily_disable_wrap(void)
 {
@@ -178,8 +182,7 @@ void gtk_infoprint_temporarily_disable_wrap(void)
  * gtk_infoprint_with_icon_stock except in always restricts
  * the text to one line and the font is emphasized.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_information instead.
+ * Deprecated: Use #hildon_banner_show_information instead.
  */
 void
 gtk_confirmation_banner(GtkWindow * parent, const gchar * text,
@@ -206,8 +209,7 @@ gtk_confirmation_banner(GtkWindow * parent, const gchar * text,
  * gtk_infoprint_with_icon_name except in always restricts
  * the text to one line and the font is emphasized.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_information instead.
+ * Deprecated: Use #hildon_banner_show_information instead.
  */
 void
 gtk_confirmation_banner_with_icon_name(GtkWindow * parent, const gchar * text,
@@ -224,8 +226,7 @@ gtk_confirmation_banner_with_icon_name(GtkWindow * parent, const gchar * text,
  * The @text is the text shown in banner.
  * Creates a new banner with the animation.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_animation instead.
+ * Deprecated: Use #hildon_banner_show_animation instead.
  */
 void gtk_banner_show_animation(GtkWindow * parent, const gchar * text)
 {
@@ -240,8 +241,7 @@ void gtk_banner_show_animation(GtkWindow * parent, const gchar * text)
  * The @text is the text shown in banner.
  * Creates a new banner with the progressbar.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_show_progress instead.
+ * Deprecated: Use #hildon_banner_show_progress instead.
  */
 void gtk_banner_show_bar(GtkWindow * parent, const gchar * text)
 {
@@ -256,8 +256,7 @@ void gtk_banner_show_bar(GtkWindow * parent, const gchar * text)
  * The @text is the text shown in banner.
  * Sets the banner text.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_set_text instead.
+ * Deprecated: Use #hildon_banner_set_text instead.
  */
 void gtk_banner_set_text(GtkWindow * parent, const gchar * text)
 {
@@ -279,8 +278,7 @@ void gtk_banner_set_text(GtkWindow * parent, const gchar * text)
  * the scale is from 0.0 to 1.0.
  * Sets the amount of fraction the progressbar has.
  *
- * This function is deprecated and should not be used.
- * Use #hildon_banner_set_fraction instead.
+ * Deprecated: Use #hildon_banner_set_fraction instead.
  */
 void gtk_banner_set_fraction(GtkWindow * parent, gdouble fraction)
 {
@@ -299,7 +297,7 @@ void gtk_banner_set_fraction(GtkWindow * parent, gdouble fraction)
  *
  * Destroys the banner
  *
- * This function is deprecated and should not be used.
+ * Deprecated:
  */
 void gtk_banner_close(GtkWindow * parent)
 {
@@ -318,8 +316,9 @@ void gtk_banner_close(GtkWindow * parent)
  * Will disable wrapping for the next shown banner. This only
  * affects next banner shown in this application.
  *
- * This function is deprecated and should not be used.
  * Currently it does nothing.
+ *
+ * Deprecated:
  **/
 void gtk_banner_temporarily_disable_wrap(void)
 {
index 3a7fd27..1705344 100644 (file)
 
 /**
  * SECTION:hildon-app
- * @short_description: A base widget to present application
+ * @short_description: A base widget to present application. Deprecated, use #HildonProgram instead.
  * @see_also: #HildonAppView
  *
  * #HildonApp is the base for any hildon application.
  * It controls basic looks and functionality of an application, like a title.
+ *
+ * This widget is deprecated use #HildonProgram instead.
  */
 
 #include <gdk/gdk.h>
@@ -2062,8 +2064,8 @@ void hildon_app_unregister_view(HildonApp *self, gpointer view_ptr)
 
 /**
  * hildon_app_unregister_view_with_id:
- * @self : a #HildonApp
- * @view_id : the ID of the view that should be unregistered
+ * @self: a #HildonApp
+ * @view_id: the ID of the view that should be unregistered
  * 
  * Unregisters a view with specified ID, if it exists.
  */
index 4bcb494..aa32e5f 100644 (file)
@@ -787,7 +787,7 @@ void hildon_banner_set_fraction(HildonBanner *self, gdouble fraction)
 
 
 /**
- * This function is deprecated and should not be used.
+ * Deprecated: really, do NOT use.
  */
 void _hildon_gtk_label_set_text_n_lines(GtkLabel *label, const gchar *text, gint max_lines)
 {
index 68a8278..96c16af 100644 (file)
@@ -38,7 +38,8 @@ G_BEGIN_DECLS
 
 /**
  * HILDON_CALENDAR_POPUP_TYPE:
- * Deprecated: use HILDON_TYPE_CALENDAR_POPUP instead
+ *
+ * Deprecated: use #HILDON_TYPE_CALENDAR_POPUP instead
  */
 #define HILDON_CALENDAR_POPUP_TYPE HILDON_TYPE_CALENDAR_POPUP
 
index 3f23a66..5debecc 100644 (file)
@@ -39,7 +39,8 @@ G_BEGIN_DECLS
 
 /**
  * HILDON_DATE_EDITOR_TYPE:
- * Deprectaed: use HILDON_TYPE_DATE_EDITOR instead
+ *
+ * Deprecated: use #HILDON_TYPE_DATE_EDITOR instead
  */
 #define HILDON_DATE_EDITOR_TYPE HILDON_TYPE_DATE_EDITOR
 
index 38f029b..2fb7cd3 100644 (file)
@@ -305,10 +305,9 @@ GtkWidget *hildon_name_password_dialog_new(GtkWindow * parent)
  *
  * Returns: the newly created #HildonNamePasswordDialog
  */
-GtkWidget *hildon_name_password_dialog_new_with_default
-                                          (GtkWindow   * parent,
-                                          const gchar * name,
-                                          const gchar * password)
+GtkWidget *hildon_name_password_dialog_new_with_default(GtkWindow   *parent,
+                                                       const gchar *name,
+                                                       const gchar *password)
 {
     GtkWidget *self = hildon_name_password_dialog_new(parent);
 
index 7ccc808..5519318 100644 (file)
@@ -459,7 +459,6 @@ hildon_note_rebuild(HildonNote *note)
  *   correctly.
  *   In GTK the X window ID can be checked using
  *   GDK_WINDOW_XID(GTK_WIDGET(parent)->window).
- *
  * @description: the message to confirm
  * @Varargs: arguments pairs for new buttons(label and return value). 
  *   Terminate the list with %NULL value.
@@ -470,15 +469,15 @@ hildon_note_rebuild(HildonNote *note)
  * default ok/cancel buttons are not appended but you have to provide
  * all of the buttons.
  *
+ * FIXME: This doc seems to be wrong, the two buttons aren't added so
+ * it would only contain the "additional" buttons? However, changing
+ * this would break those applications that rely on current behaviour.
+ *
  * Returns: A #GtkWidget pointer of the note
  */
-
-/* FIXME: This doc seems to be wrong, the two buttons aren't added so it
- * would only contain the "additional" buttons? However, changing this would
-   break those applications that rely on current behaviour. */
-GtkWidget *hildon_note_new_confirmation_add_buttons(GtkWindow * parent,
-                                                    const gchar *
-                                                    description, ...)
+GtkWidget *hildon_note_new_confirmation_add_buttons(GtkWindow   *parent,
+                                                    const gchar *description,
+                                                   ...)
 {
     va_list args;
     char *message;
@@ -718,7 +717,6 @@ GtkWidget *hildon_note_new_information_with_icon_name(GtkWindow * parent,
  *   important so that the window manager could handle the windows
  *   correctly. In GTK the X window ID can be checked using
  *   GDK_WINDOW_XID(GTK_WIDGET(parent)->window).
- *
  * @description: the message to confirm
  * @icon: #GtkIconTheme icon to be displayed
  * 
index 70504d4..f0a4c7d 100644 (file)
@@ -38,7 +38,8 @@ G_BEGIN_DECLS
 
 /**
  * HILDON_RANGE_EDITOR_TYPE
- * Deprectated: use HILDON_TYPE_RANGE_EDITOR instead
+ *
+ * Deprecated: use #HILDON_TYPE_RANGE_EDITOR instead
  */
 #define HILDON_RANGE_EDITOR_TYPE HILDON_TYPE_RANGE_EDITOR
 
index 13d35b8..bb4836d 100644 (file)
@@ -663,8 +663,7 @@ static void hildon_time_editor_finalize(GObject * obj_self)
         G_OBJECT_CLASS(parent_class)->finalize(obj_self);
 }
 
-/**
- * Gets hour-minute separator and minute-second separator 
+/* Gets hour-minute separator and minute-second separator 
  * from current locale
  */
 static void get_time_separators(HildonTimeEditorPrivate *priv)
index 93b629d..1076e82 100644 (file)
@@ -39,7 +39,8 @@ G_BEGIN_DECLS
 
 /**
  * HILDON_VOLUMEBAR_RANGE_TYPE
- * Deprectated: use HILDON_VOLUMEBAR_RANGE_TYPE instead
+ *
+ * Deprecated: use #HILDON_VOLUMEBAR_RANGE_TYPE instead
  */
 #define HILDON_VOLUMEBAR_RANGE_TYPE HILDON_TYPE_VOLUMEBAR_RANGE
 
index bcaa8cc..03e7cdf 100644 (file)
@@ -38,7 +38,8 @@ G_BEGIN_DECLS
 
 /**
  * HILDON_WEEKDAY_PICKER_TYPE:
- * Deprecated: use HILDON_TYPE_WEEKDAY_PICKER instead.
+ *
+ * Deprecated: use #HILDON_TYPE_WEEKDAY_PICKER instead.
  */
 #define HILDON_WEEKDAY_PICKER_TYPE HILDON_TYPE_WEEKDAY_PICKER