From 204ad2817590e6564402abc918512585b46298c3 Mon Sep 17 00:00:00 2001 From: Alberto Garcia Date: Mon, 6 Apr 2009 17:53:46 +0000 Subject: [PATCH] 2009-04-06 Alberto Garcia * src/hildon-animation-actor.c * src/hildon-button.c * src/hildon-main.c * src/hildon-pannable-area.c * src/hildon-picker-button.c * src/hildon-program.c * src/hildon-remote-texture.c * src/hildon-text-view.c * src/hildon-touch-selector.c * src/hildon-window-stack.c * src/hildon-window.c: Add missing 'Since: 2.2' tags. * doc/hildon-sections.txt: Add some missing symbols. * doc/hildon-docs.sgml: New 'Other' section for HildonAnimationActor and HildonRemoteTexture --- ChangeLog | 22 +++++++++++++ doc/hildon-docs.sgml | 6 ++++ doc/hildon-sections.txt | 74 ++++++++++++++++++++++++++++++++++++++++++ src/hildon-animation-actor.c | 30 +++++++++++++++++ src/hildon-button.c | 9 ++++- src/hildon-main.c | 2 ++ src/hildon-pannable-area.c | 11 +++++++ src/hildon-picker-button.c | 2 ++ src/hildon-program.c | 6 ++++ src/hildon-remote-texture.c | 22 +++++++++++++ src/hildon-text-view.c | 2 +- src/hildon-touch-selector.c | 2 ++ src/hildon-window-stack.c | 4 ++- src/hildon-window.c | 8 +++++ 14 files changed, 197 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index 83f8135..324faa3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,27 @@ 2009-04-06 Alberto Garcia + * src/hildon-animation-actor.c + * src/hildon-button.c + * src/hildon-main.c + * src/hildon-pannable-area.c + * src/hildon-picker-button.c + * src/hildon-program.c + * src/hildon-remote-texture.c + * src/hildon-text-view.c + * src/hildon-touch-selector.c + * src/hildon-window-stack.c + * src/hildon-window.c: + Add missing 'Since: 2.2' tags. + + * doc/hildon-sections.txt: + Add some missing symbols. + + * doc/hildon-docs.sgml: + New 'Other' section for HildonAnimationActor and + HildonRemoteTexture + +2009-04-06 Alberto Garcia + Patch by Iván Gómez (igomez@igalia.com) * doc/building.sgml diff --git a/doc/hildon-docs.sgml b/doc/hildon-docs.sgml index f9c81d2..6f49b97 100644 --- a/doc/hildon-docs.sgml +++ b/doc/hildon-docs.sgml @@ -153,6 +153,12 @@ + Other + + + + + Deprecated diff --git a/doc/hildon-sections.txt b/doc/hildon-sections.txt index 402ecdb..475c84f 100644 --- a/doc/hildon-sections.txt +++ b/doc/hildon-sections.txt @@ -1,4 +1,76 @@
+hildon-animation-actor +HildonAnimationActor +HildonAnimationActor +hildon_animation_actor_new +hildon_animation_actor_send_message +hildon_animation_actor_set_anchor +hildon_animation_actor_set_anchor_from_gravity +hildon_animation_actor_set_depth +hildon_animation_actor_set_opacity +hildon_animation_actor_set_parent +hildon_animation_actor_set_position +hildon_animation_actor_set_position_full +hildon_animation_actor_set_rotation +hildon_animation_actor_set_rotationx +hildon_animation_actor_set_scale +hildon_animation_actor_set_scalex +hildon_animation_actor_set_show +hildon_animation_actor_set_show_full +HILDON_AA_CENTER_GRAVITY +HILDON_AA_E_GRAVITY +HILDON_AA_NE_GRAVITY +HILDON_AA_NW_GRAVITY +HILDON_AA_N_GRAVITY +HILDON_AA_SE_GRAVITY +HILDON_AA_SW_GRAVITY +HILDON_AA_S_GRAVITY +HILDON_AA_W_GRAVITY +HILDON_AA_X_AXIS +HILDON_AA_Y_AXIS +HILDON_AA_Z_AXIS + +HILDON_ANIMATION_ACTOR +HILDON_ANIMATION_ACTOR_CLASS +HILDON_ANIMATION_ACTOR_GET_CLASS +HILDON_ANIMATION_ACTOR_GET_PRIVATE +HILDON_IS_ANIMATION_ACTOR +HILDON_IS_ANIMATION_ACTOR_CLASS +HILDON_TYPE_ANIMATION_ACTOR +HildonAnimationActorClass +HildonAnimationActorPrivate +hildon_animation_actor_get_type +
+ +
+hildon-remote-texture +HildonRemoteTexture +HildonRemoteTexture +hildon_remote_texture_new +hildon_remote_texture_send_message +hildon_remote_texture_set_image +hildon_remote_texture_set_offset +hildon_remote_texture_set_opacity +hildon_remote_texture_set_parent +hildon_remote_texture_set_position +hildon_remote_texture_set_scale +hildon_remote_texture_set_show +hildon_remote_texture_set_show_full +hildon_remote_texture_update_area + +HILDON_IS_REMOTE_TEXTURE +HILDON_IS_REMOTE_TEXTURE_CLASS +HILDON_REMOTE_TEXTURE +HILDON_REMOTE_TEXTURE_CLASS +HILDON_REMOTE_TEXTURE_GET_CLASS +HILDON_REMOTE_TEXTURE_GET_PRIVATE +HILDON_TYPE_REMOTE_TEXTURE +HildonRemoteTextureClass +HildonRemoteTexturePrivate +hildon_remote_texture_get_type +
+ +
hildon-date-selector HildonDateSelector HildonDateSelector @@ -906,6 +978,7 @@ hildon_touch_selector_get_model hildon_touch_selector_get_current_text hildon_touch_selector_set_print_func hildon_touch_selector_get_print_func +hildon_touch_selector_set_print_func_full hildon_touch_selector_has_multiple_selection HILDON_TOUCH_SELECTOR @@ -1258,6 +1331,7 @@ HILDON_HARDKEY_ESC HILDON_HARDKEY_FULLSCREEN HILDON_HARDKEY_INCREASE HILDON_HARDKEY_DECREASE +HILDON_WINDOW_TITLEBAR_HEIGHT hildon_get_icon_pixel_size
diff --git a/src/hildon-animation-actor.c b/src/hildon-animation-actor.c index 4f4ece7..0d623d8 100644 --- a/src/hildon-animation-actor.c +++ b/src/hildon-animation-actor.c @@ -308,6 +308,8 @@ hildon_animation_actor_init (HildonAnimationActor *self) * Creates a new #HildonAnimationActor. * * Return value: A #HildonAnimationActor + * + * Since: 2.2 **/ GtkWidget* hildon_animation_actor_new (void) @@ -521,6 +523,8 @@ hildon_animation_actor_send_all_messages (HildonAnimationActor *self) * * This is an internal utility function that application will * not need to call directly. + * + * Since: 2.2 **/ void hildon_animation_actor_send_message (HildonAnimationActor *self, @@ -593,6 +597,8 @@ hildon_animation_actor_send_message (HildonAnimationActor *self, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_show_full (HildonAnimationActor *self, @@ -637,6 +643,8 @@ hildon_animation_actor_set_show_full (HildonAnimationActor *self, * This function is a shortcut for hildon_animation_actor_set_show_full(), * setting the overall actor visibility without changing it's opacity * setting. + * + * Since: 2.2 **/ void hildon_animation_actor_set_show (HildonAnimationActor *self, @@ -659,6 +667,8 @@ hildon_animation_actor_set_show (HildonAnimationActor *self, * * See hildon_animation_actor_set_show_full() for description of the range * of values @opacity argument takes. + * + * Since: 2.2 **/ void hildon_animation_actor_set_opacity (HildonAnimationActor *self, @@ -701,6 +711,8 @@ hildon_animation_actor_set_opacity (HildonAnimationActor *self, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_position_full (HildonAnimationActor *self, @@ -735,6 +747,8 @@ hildon_animation_actor_set_position_full (HildonAnimationActor *self, * * A shortcut for hildon_animation_actor_set_position_full(), * changing the window position, but preserving it's depth setting. + * + * Since: 2.2 **/ void hildon_animation_actor_set_position (HildonAnimationActor *self, @@ -755,6 +769,8 @@ hildon_animation_actor_set_position (HildonAnimationActor *self, * * A shortcut for hildon_animation_actor_set_position_full(), * changing the window depth, but preserving it's position. + * + * Since: 2.2 **/ void hildon_animation_actor_set_depth (HildonAnimationActor *self, @@ -777,6 +793,8 @@ hildon_animation_actor_set_depth (HildonAnimationActor *self, * * This function is just like hildon_animation_actor_set_scale(), * but the scale factors are given as 16-bit fixed-point number. + * + * Since: 2.2 **/ void hildon_animation_actor_set_scalex (HildonAnimationActor *self, @@ -817,6 +835,8 @@ hildon_animation_actor_set_scalex (HildonAnimationActor *self, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_scale (HildonAnimationActor *self, @@ -840,6 +860,8 @@ hildon_animation_actor_set_scale (HildonAnimationActor *self, * * This function is just like hildon_animation_actor_set_rotation(), * but the rotation angle is given as 16-bit fixed-point number. + * + * Since: 2.2 **/ void hildon_animation_actor_set_rotationx (HildonAnimationActor *self, @@ -909,6 +931,8 @@ hildon_animation_actor_set_rotationx (HildonAnimationActor *self, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_rotation (HildonAnimationActor *self, @@ -935,6 +959,8 @@ hildon_animation_actor_set_rotation (HildonAnimationActor *self, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_anchor (HildonAnimationActor *self, @@ -983,6 +1009,8 @@ hildon_animation_actor_set_anchor (HildonAnimationActor *self, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_anchor_from_gravity (HildonAnimationActor *self, @@ -1072,6 +1100,8 @@ hildon_animation_actor_map_event (GtkWidget *widget, * * If the animation actor WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_animation_actor_set_parent (HildonAnimationActor *self, diff --git a/src/hildon-button.c b/src/hildon-button.c index 25a1678..23ee096 100644 --- a/src/hildon-button.c +++ b/src/hildon-button.c @@ -347,6 +347,8 @@ hildon_button_init (HildonButton *self) * @size_group: A #GtkSizeGroup for the button title (main label) * * Adds the title label of @button to @size_group. + * + * Since: 2.2 **/ void hildon_button_add_title_size_group (HildonButton *button, @@ -368,6 +370,8 @@ hildon_button_add_title_size_group (HildonButton *button, * @size_group: A #GtkSizeGroup for the button value (secondary label) * * Adds the value label of @button to @size_group. + * + * Since: 2.2 **/ void hildon_button_add_value_size_group (HildonButton *button, @@ -390,6 +394,8 @@ hildon_button_add_value_size_group (HildonButton *button, * * Adds the image of @button to @size_group. You must add an image * using hildon_button_set_image() before calling this function. + * + * Since: 2.2 **/ void hildon_button_add_image_size_group (HildonButton *button, @@ -416,6 +422,8 @@ hildon_button_add_image_size_group (HildonButton *button, * * Convenience function to add title, value and image to size * groups. %NULL size groups will be ignored. + * + * Since: 2.2 **/ void hildon_button_add_size_groups (HildonButton *button, @@ -566,7 +574,6 @@ hildon_button_set_title (HildonButton *button, * If @value is set to %NULL, the value label will be hidden and the * title label will be realigned. * - * * Since: 2.2 **/ void diff --git a/src/hildon-main.c b/src/hildon-main.c index 10782e9..4713af9 100644 --- a/src/hildon-main.c +++ b/src/hildon-main.c @@ -74,6 +74,7 @@ * Initializes the hildon library. Call this function after calling gtk_init() * and before using any hildon or GTK+ functions in your program. * + * Since: 2.2 **/ void hildon_init (void) @@ -110,6 +111,7 @@ hildon_init (void) * libraries. Use this function to replace a call to gtk_init() and also * initialize the hildon library. See hildon_init() and gtk_init() for details. * + * Since: 2.2 **/ void hildon_gtk_init (int *argc, char ***argv) diff --git a/src/hildon-pannable-area.c b/src/hildon-pannable-area.c index d2a0a0c..c78e749 100644 --- a/src/hildon-pannable-area.c +++ b/src/hildon-pannable-area.c @@ -570,6 +570,8 @@ hildon_pannable_area_class_init (HildonPannableAreaClass * klass) * * The horizontal-movement signal is emitted when the pannable area * starts a horizontal movement. + * + * Since: 2.2 */ pannable_area_signals[HORIZONTAL_MOVEMENT] = g_signal_new ("horizontal_movement", @@ -592,6 +594,8 @@ hildon_pannable_area_class_init (HildonPannableAreaClass * klass) * * The vertical-movement signal is emitted when the pannable area * starts a vertical movement. + * + * Since: 2.2 */ pannable_area_signals[VERTICAL_MOVEMENT] = g_signal_new ("vertical_movement", @@ -3161,6 +3165,8 @@ hildon_pannable_get_child_widget_at (HildonPannableArea *area, * artifacts in the animations. * * returns: The horizontal #GtkAdjustment + * + * Since: 2.2 **/ GtkAdjustment* hildon_pannable_area_get_hadjustment (HildonPannableArea *area) @@ -3182,6 +3188,8 @@ hildon_pannable_area_get_hadjustment (HildonPannableArea *area) * artifacts in the animations. * * returns: The vertical #GtkAdjustment + * + * Since: 2.2 **/ GtkAdjustment* hildon_pannable_area_get_vadjustment (HildonPannableArea *area) @@ -3204,6 +3212,8 @@ hildon_pannable_area_get_vadjustment (HildonPannableArea *area) * * returns: the policy is currently being used in the widget * #HildonSizeRequestPolicy. + * + * Since: 2.2 **/ HildonSizeRequestPolicy hildon_pannable_area_get_size_request_policy (HildonPannableArea *area) @@ -3232,6 +3242,7 @@ hildon_pannable_area_get_size_request_policy (HildonPannableArea *area) * parameter will not have any effect with * #HILDON_SIZE_REQUEST_MINIMUM set. * + * Since: 2.2 **/ void hildon_pannable_area_set_size_request_policy (HildonPannableArea *area, diff --git a/src/hildon-picker-button.c b/src/hildon-picker-button.c index de2bd20..dd5d300 100644 --- a/src/hildon-picker-button.c +++ b/src/hildon-picker-button.c @@ -186,6 +186,8 @@ hildon_picker_button_finalize (GObject * object) * * Emits a "#HildonPickerButton::value-changed" signal to the given * #HildonPickerButton + * + * Since: 2.2 **/ void hildon_picker_button_value_changed (HildonPickerButton *button) diff --git a/src/hildon-program.c b/src/hildon-program.c index 79639a3..47ead29 100644 --- a/src/hildon-program.c +++ b/src/hildon-program.c @@ -274,6 +274,8 @@ hildon_program_get_property (GObject *object, * Deprecated: Use hildon_window_stack_pop() instead * * Returns: A #HildonStackableWindow, or %NULL + * + * Since: 2.2 */ HildonStackableWindow * hildon_program_pop_window_stack (HildonProgram *self) @@ -291,6 +293,8 @@ hildon_program_pop_window_stack (HildonProgram *self) * Deprecated: Use hildon_window_stack_peek() instead * * Returns: A #HildonStackableWindow, or %NULL + * + * Since: 2.2 */ HildonStackableWindow * hildon_program_peek_window_stack (HildonProgram *self) @@ -824,6 +828,8 @@ hildon_program_get_is_topmost (HildonProgram *self) * Goes to the root window of the stack. * * Deprecated: See #HildonWindowStack + * + * Since: 2.2 */ void hildon_program_go_to_root_window (HildonProgram *self) diff --git a/src/hildon-remote-texture.c b/src/hildon-remote-texture.c index 2845c7e..f8bbbd7 100644 --- a/src/hildon-remote-texture.c +++ b/src/hildon-remote-texture.c @@ -200,6 +200,8 @@ hildon_remote_texture_init (HildonRemoteTexture *self) * Creates a new #HildonRemoteTexture. * * Return value: A #HildonRemoteTexture + * + * Since: 2.2 **/ GtkWidget* hildon_remote_texture_new (void) @@ -395,6 +397,8 @@ hildon_remote_texture_send_all_messages (HildonRemoteTexture *self) * * This is an internal utility function that application will * not need to call directly. + * + * Since: 2.2 **/ void hildon_remote_texture_send_message (HildonRemoteTexture *self, @@ -442,6 +446,8 @@ hildon_remote_texture_send_message (HildonRemoteTexture *self, * @width: width of image in pixels * @height: height of image in pixels * @bpp: BYTES per pixel - usually 2,3 or 4 + * + * Since: 2.2 */ void hildon_remote_texture_set_image (HildonRemoteTexture *self, @@ -488,6 +494,8 @@ hildon_remote_texture_set_image (HildonRemoteTexture *self, * This signals to hildon-desktop that a specific region of the memory area * has changed. This will trigger a redraw and will update the relevant tiles * of the texture. + * + * Since: 2.2 */ void hildon_remote_texture_update_area (HildonRemoteTexture *self, @@ -558,6 +566,8 @@ hildon_remote_texture_update_area (HildonRemoteTexture *self, * * If the remote texture WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_remote_texture_set_show_full (HildonRemoteTexture *self, @@ -600,6 +610,8 @@ hildon_remote_texture_set_show_full (HildonRemoteTexture *self, * This function is a shortcut for hildon_remote_texture_set_show_full(), * setting the overall actor visibility without changing it's opacity * setting. + * + * Since: 2.2 **/ void hildon_remote_texture_set_show (HildonRemoteTexture *self, @@ -622,6 +634,8 @@ hildon_remote_texture_set_show (HildonRemoteTexture *self, * * See hildon_remote_texture_set_show_full() for description of the range * of values @opacity argument takes. + * + * Since: 2.2 **/ void hildon_remote_texture_set_opacity (HildonRemoteTexture *self, @@ -649,6 +663,8 @@ hildon_remote_texture_set_opacity (HildonRemoteTexture *self, * * If the remote texture WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_remote_texture_set_position (HildonRemoteTexture *self, @@ -695,6 +711,8 @@ hildon_remote_texture_set_position (HildonRemoteTexture *self, * * If the remote texture WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_remote_texture_set_offset (HildonRemoteTexture *self, @@ -729,6 +747,8 @@ hildon_remote_texture_set_offset (HildonRemoteTexture *self, * @self: A #HildonRemoteTexture * @x_scale: The scale factor for the memory area to be rendered in the X-axis * @y_scale: The scale factor for the memory area to be rendered in the X-axis + * + * Since: 2.2 **/ void hildon_remote_texture_set_scale (HildonRemoteTexture *self, @@ -825,6 +845,8 @@ hildon_remote_texture_map_event (GtkWidget *widget, * * If the remote texture WM-counterpart is not ready, the show message * will be queued until the WM is ready for it. + * + * Since: 2.2 **/ void hildon_remote_texture_set_parent (HildonRemoteTexture *self, diff --git a/src/hildon-text-view.c b/src/hildon-text-view.c index b219b5a..4630999 100644 --- a/src/hildon-text-view.c +++ b/src/hildon-text-view.c @@ -202,7 +202,7 @@ hildon_text_view_set_placeholder (HildonTextView *text_view, * * Returns: a new #HildonTextView * - * Since: 2.2 + * Since: 2.2 */ GtkWidget * hildon_text_view_new (void) diff --git a/src/hildon-touch-selector.c b/src/hildon-touch-selector.c index 1e53c6f..7a7031c 100644 --- a/src/hildon-touch-selector.c +++ b/src/hildon-touch-selector.c @@ -335,6 +335,7 @@ hildon_touch_selector_class_init (HildonTouchSelectorClass * class) * This can be due to the user selecting a different item from the list, or * due to a call to hildon_touch_selector_select_iter() on one of the columns. * + * Since: 2.2 */ hildon_touch_selector_signals[CHANGED] = g_signal_new ("changed", @@ -351,6 +352,7 @@ hildon_touch_selector_class_init (HildonTouchSelectorClass * class) * The "columns-changed" signal is emitted when the number * of columns in the #HildonTouchSelector change. * + * Since: 2.2 */ hildon_touch_selector_signals[COLUMNS_CHANGED] = g_signal_new ("columns-changed", diff --git a/src/hildon-window-stack.c b/src/hildon-window-stack.c index 1d63ffc..925d9fd 100644 --- a/src/hildon-window-stack.c +++ b/src/hildon-window-stack.c @@ -105,7 +105,7 @@ hildon_window_stack_get_window_group (HildonWindowStack *stack) * doesn't need to be created by the application. * * Return value: the default #HildonWindowStack - * + * * Since: 2.2 **/ HildonWindowStack * @@ -233,6 +233,8 @@ hildon_window_stack_remove (HildonStackableWindow *win) * done with the list you must call g_list_free(). * * Returns: a newly-allocated list of #HildonStackableWindows + * + * Since: 2.2 **/ GList * hildon_window_stack_get_windows (HildonWindowStack *stack) diff --git a/src/hildon-window.c b/src/hildon-window.c index d0a85b3..8d8e2f5 100644 --- a/src/hildon-window.c +++ b/src/hildon-window.c @@ -1845,6 +1845,8 @@ hildon_window_remove_toolbar (HildonWindow *self, * * A window can only have at most one edit toolbar at a time, so the * previous toolbar (if any) is replaced after calling this function. + * + * Since: 2.2 **/ void hildon_window_set_edit_toolbar (HildonWindow *self, @@ -1881,6 +1883,8 @@ hildon_window_set_edit_toolbar (HildonWindow *self, * you should use hildon_window_get_app_menu() instead. * * Return value: The #GtkMenu assigned to this application view. + * + * Since: 2.2 **/ GtkMenu* hildon_window_get_main_menu (HildonWindow * self) @@ -2119,6 +2123,8 @@ hildon_window_update_markup (HildonWindow *window) * Returns: the marked up title of the window, or %NULL if none has * been set explicitely. The returned string is owned by the widget * and must not be modified or freed. + * + * Since: 2.2 **/ const gchar * hildon_window_get_markup (HildonWindow *window) @@ -2145,6 +2151,8 @@ hildon_window_get_markup (HildonWindow *window) * Note that you need support from the window manager for this title * to be used. See gtk_window_set_title() for the standard way of * setting the title of a window. + * + * Since: 2.2 **/ void hildon_window_set_markup (HildonWindow *window, -- 1.7.9.5