[gtk+/resolution-independence: 24/24] [RI] Update gtk-doc for Since: and cross referencing

From: Davyd Madeley <davyd src gnome org>
To: svn-commits-list gnome org
Subject: [gtk+/resolution-independence: 24/24] [RI] Update gtk-doc for Since: and cross referencing
Date: Sat, 2 May 2009 02:19:02 -0400 (EDT)
commit 127e8d8a1b375450d9818a112a6719f107939519
Author: Davyd Madeley <davyd madeley id au>
Date:   Fri May 1 12:42:49 2009 +0800

    [RI] Update gtk-doc for Since: and cross referencing
    
    All "Since: 2.14" have been replaced by "Since: RIMERGE". When this is finally
    merged, these should be replaced with the appropriate GTK+ version and then
    that patch should be squashed into this one.
    
    Also clarified some of the entires in the doc, for pixels vs units. Added
    cross references to the unit-aware versions of functions.
---
 gdk/gdkpango.c          |    2 +-
 gdk/gdkscreen.c         |    8 ++--
 gtk/gtkalignment.c      |    7 ++--
 gtk/gtkbox.c            |    4 +-
 gtk/gtkcellrenderer.c   |   14 ++++++--
 gtk/gtkcontainer.c      |    6 ++-
 gtk/gtkexpander.c       |    5 ++-
 gtk/gtkhsv.c            |    5 ++-
 gtk/gtkiconfactory.c    |    6 ++--
 gtk/gtkiconview.c       |   25 +++++++++------
 gtk/gtkimage.c          |    5 ++-
 gtk/gtkmisc.c           |    6 ++-
 gtk/gtksettings.c       |    2 +-
 gtk/gtksize.c           |   32 +++++++++---------
 gtk/gtksize.h           |   14 ++++----
 gtk/gtktable.c          |   28 +++++++++++------
 gtk/gtktextview.c       |   79 ++++++++++++++++++++++++++++++++++------------
 gtk/gtktreeview.c       |    5 ++-
 gtk/gtktreeviewcolumn.c |   19 ++++++++---
 gtk/gtkwidget.c         |   10 +++---
 gtk/gtkwindow.c         |    4 +-
 21 files changed, 179 insertions(+), 107 deletions(-)

diff --git a/gdk/gdkpango.c b/gdk/gdkpango.c
index 27c09be..b469e21 100644
--- a/gdk/gdkpango.c
+++ b/gdk/gdkpango.c
@@ -1506,7 +1506,7 @@ gdk_pango_context_get_for_screen (GdkScreen *screen)
  * 
  * Return value: a new #PangoContext for @screen
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 PangoContext *
 gdk_pango_context_get_for_screen_for_monitor (GdkScreen *screen,
diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c
index 1df89bb..0ffa9fc 100644
--- a/gdk/gdkscreen.c
+++ b/gdk/gdkscreen.c
@@ -436,7 +436,7 @@ gdk_screen_set_font_options (GdkScreen                  *screen,
  *
  * Like gdk_screen_set_font_options() but per monitor.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gdk_screen_set_font_options_for_monitor (GdkScreen                  *screen,
@@ -476,7 +476,7 @@ gdk_screen_get_font_options (GdkScreen *screen)
  * Return value: the current font options, or %NULL if no default
  *  font options have been set.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 const cairo_font_options_t *
 gdk_screen_get_font_options_for_monitor (GdkScreen *screen,
@@ -546,7 +546,7 @@ gdk_screen_get_resolution (GdkScreen *screen)
  * Returns: the current resolution or -1 if no resolution has been
  * set.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gdouble
 gdk_screen_get_resolution_for_monitor (GdkScreen *screen,
@@ -569,7 +569,7 @@ gdk_screen_get_resolution_for_monitor (GdkScreen *screen,
  *
  * Like gdk_screen_set_resolution() but per monitor.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gdk_screen_set_resolution_for_monitor (GdkScreen *screen,
diff --git a/gtk/gtkalignment.c b/gtk/gtkalignment.c
index 2b320ba..59baf8a 100644
--- a/gtk/gtkalignment.c
+++ b/gtk/gtkalignment.c
@@ -554,8 +554,9 @@ gtk_alignment_set_padding (GtkAlignment    *alignment,
  * @padding_left: location to store the padding for the left of the widget, or %NULL
  * @padding_right: location to store the padding for the right of the widget, or %NULL
  *
- * Gets the padding on the different sides of the widget.
- * See gtk_alignment_set_padding ().
+ * Gets the padding in pixels on the different sides of the widget.
+ * See gtk_alignment_set_padding (). Use gtk_alignment_get_padding_unit() to
+ * preserve units.
  *
  * Since: 2.4
  */
@@ -591,7 +592,7 @@ gtk_alignment_get_padding (GtkAlignment    *alignment,
  *
  * Like gtk_alignment_get_padding() but preserves the unit.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 void
 gtk_alignment_get_padding_unit (GtkAlignment    *alignment,
diff --git a/gtk/gtkbox.c b/gtk/gtkbox.c
index e085545..7163622 100644
--- a/gtk/gtkbox.c
+++ b/gtk/gtkbox.c
@@ -1069,7 +1069,7 @@ _gtk_box_get_spacing_set (GtkBox *box)
  * 
  * Return value: spacing between children
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_box_get_spacing_unit (GtkBox *box)
@@ -1205,7 +1205,7 @@ gtk_box_query_child_packing (GtkBox      *box,
  * 
  * Like gtk_box_query_child_packing_unit() but preserves units.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 void
 gtk_box_query_child_packing_unit (GtkBox      *box,
diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c
index ac7f691..bc8df3c 100644
--- a/gtk/gtkcellrenderer.c
+++ b/gtk/gtkcellrenderer.c
@@ -494,6 +494,9 @@ set_cell_bg_color (GtkCellRenderer *cell,
  *
  * Please note that the values set in @width and @height, as well as those 
  * in @x_offset and @y_offset are inclusive of the xpad and ypad properties.
+ *
+ * Returns values in pixels. To preserve the units use
+ * gtk_cell_renderer_get_size_unit().
  **/
 void
 gtk_cell_renderer_get_size (GtkCellRenderer    *cell,
@@ -546,7 +549,7 @@ gtk_cell_renderer_get_size (GtkCellRenderer    *cell,
  *
  * Like gtk_cell_renderer_get_size() but preserves the units.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_cell_renderer_get_size_unit (GtkCellRenderer    *cell,
@@ -777,6 +780,9 @@ gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
  * @height: location to fill in with the fixed height of the widget, or %NULL
  * 
  * Fills in @width and @height with the appropriate size of @cell.
+ *
+ * Returns values in pixels. To preserve the units use
+ * gtk_cell_renderer_get_fixed_size_unit().
  **/
 void
 gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
@@ -799,7 +805,7 @@ gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
  * 
  * Like gtk_cell_renderer_get_fixed_size_unit() but preserves the unit information.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_cell_renderer_get_fixed_size_unit (GtkCellRenderer *cell,
@@ -884,7 +890,7 @@ _gtk_cell_renderer_set_tree_view_column (GtkCellRenderer *cell,
  * Returns: the #GtkTreeViewColumn that @cell has been inserted into,
  * %NULL otherwise
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkTreeViewColumn *
 gtk_cell_renderer_get_tree_view_column (GtkCellRenderer *cell)
@@ -909,7 +915,7 @@ gtk_cell_renderer_get_tree_view_column (GtkCellRenderer *cell)
  *
  * Returns: a #GtkTreeView
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkWidget *
 gtk_cell_renderer_get_tree_view (GtkCellRenderer *cell)
diff --git a/gtk/gtkcontainer.c b/gtk/gtkcontainer.c
index c6f6093..1113baa 100644
--- a/gtk/gtkcontainer.c
+++ b/gtk/gtkcontainer.c
@@ -1170,9 +1170,11 @@ gtk_container_set_border_width (GtkContainer *container,
  * gtk_container_get_border_width:
  * @container: a #GtkContainer
  * 
- * Retrieves the border width of the container. See
+ * Retrieves the border width of the container in pixels. See
  * gtk_container_set_border_width().
  *
+ * Use gtk_container_get_border_width_unit() to preserve units.
+ *
  * Return value: the current border width
  **/
 guint
@@ -1191,7 +1193,7 @@ gtk_container_get_border_width (GtkContainer *container)
  *
  * Return value: the current border width
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkUSize
 gtk_container_get_border_width_unit (GtkContainer *container)
diff --git a/gtk/gtkexpander.c b/gtk/gtkexpander.c
index 8977ac0..dd3686f 100644
--- a/gtk/gtkexpander.c
+++ b/gtk/gtkexpander.c
@@ -1472,7 +1472,8 @@ gtk_expander_set_spacing (GtkExpander *expander,
  * gtk_expander_get_spacing:
  * @expander: a #GtkExpander
  *
- * Gets the value set by gtk_expander_set_spacing().
+ * Gets the value set by gtk_expander_set_spacing() in pixels. Use
+ * gtk_expander_get_spacing_unit() to preserve units.
  *
  * Return value: spacing between the expander and child.
  *
@@ -1494,7 +1495,7 @@ gtk_expander_get_spacing (GtkExpander *expander)
  *
  * Return value: spacing between the expander and child.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_expander_get_spacing_unit (GtkExpander *expander)
diff --git a/gtk/gtkhsv.c b/gtk/gtkhsv.c
index 3d93149..a4b40e0 100644
--- a/gtk/gtkhsv.c
+++ b/gtk/gtkhsv.c
@@ -1488,7 +1488,8 @@ gtk_hsv_set_metrics (GtkHSV *hsv,
  * @size: Return value for the diameter of the hue ring
  * @ring_width: Return value for the width of the hue ring
  *
- * Queries the size and ring width of an HSV color selector.
+ * Queries the size and ring width of an HSV color selector in pixels.
+ * Use gtk_hsv_get_metrics_unit() to preserve units.
  *
  * Since: 2.14
  */
@@ -1518,7 +1519,7 @@ gtk_hsv_get_metrics (GtkHSV *hsv,
  *
  * Like gtk_hsv_get_metrics() but preserves the unit.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_hsv_get_metrics_unit (GtkHSV  *hsv,
diff --git a/gtk/gtkiconfactory.c b/gtk/gtkiconfactory.c
index 3eeda05..2ec4e02 100644
--- a/gtk/gtkiconfactory.c
+++ b/gtk/gtkiconfactory.c
@@ -960,7 +960,7 @@ gtk_icon_size_lookup_for_settings (GtkSettings *settings,
  * 
  * Return value: %TRUE if @size was a valid size
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gboolean
 gtk_icon_size_lookup_for_settings_for_monitor (GtkSettings *settings,
@@ -987,7 +987,7 @@ gtk_icon_size_lookup_for_settings_for_monitor (GtkSettings *settings,
  *
  * Return value: %TRUE if @size was a valid size
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gboolean
 gtk_icon_size_lookup_for_settings_unit (GtkSettings *settings,
@@ -1043,7 +1043,7 @@ gtk_icon_size_lookup (GtkIconSize  size,
  * 
  * Return value: %TRUE if @size was a valid size
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gboolean
 gtk_icon_size_lookup_unit (GtkIconSize  size,
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index 40ae71e..7f3dd6e 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -6033,7 +6033,8 @@ gtk_icon_view_set_item_width (GtkIconView *icon_view,
  * gtk_icon_view_get_item_width:
  * @icon_view: a #GtkIconView
  * 
- * Returns the value of the ::item-width property.
+ * Returns the value of the ::item-width property in pixels. To preserve
+ * the units use gtk_icon_view_get_item_width_unit().
  * 
  * Return value: the width of a single item, or -1
  *
@@ -6055,7 +6056,7 @@ gtk_icon_view_get_item_width (GtkIconView *icon_view)
  * 
  * Return value: the width_unit of a single item, or -1
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_icon_view_get_item_width_unit (GtkIconView *icon_view)
@@ -6099,7 +6100,8 @@ gtk_icon_view_set_spacing (GtkIconView *icon_view,
  * gtk_icon_view_get_spacing:
  * @icon_view: a #GtkIconView
  * 
- * Returns the value of the ::spacing property.
+ * Returns the value of the ::spacing property in pixels. To preserve the units
+ * use gtk_icon_view_get_spacing_unit().
  * 
  * Return value: the space between cells 
  *
@@ -6121,7 +6123,7 @@ gtk_icon_view_get_spacing (GtkIconView *icon_view)
  * 
  * Return value: the space between cells 
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_icon_view_get_spacing_unit (GtkIconView *icon_view)
@@ -6163,7 +6165,8 @@ gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
  * gtk_icon_view_get_row_spacing:
  * @icon_view: a #GtkIconView
  * 
- * Returns the value of the ::row-spacing property.
+ * Returns the value of the ::row-spacing property in pixels. To preserve the
+ * units use gtk_icon_view_get_row_spacing_unit().
  * 
  * Return value: the space between rows
  *
@@ -6185,7 +6188,7 @@ gtk_icon_view_get_row_spacing (GtkIconView *icon_view)
  * 
  * Return value: the space between rows
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_icon_view_get_row_spacing_unit (GtkIconView *icon_view)
@@ -6227,7 +6230,8 @@ gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
  * gtk_icon_view_get_column_spacing:
  * @icon_view: a #GtkIconView
  * 
- * Returns the value of the ::column-spacing property.
+ * Returns the value of the ::column-spacing property in pixels. To preserve
+ * the units use gtk_icon_view_get_column_spacing_unit().
  * 
  * Return value: the space between columns
  *
@@ -6249,7 +6253,7 @@ gtk_icon_view_get_column_spacing (GtkIconView *icon_view)
  * 
  * Return value: the space between columns
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_icon_view_get_column_spacing_unit (GtkIconView *icon_view)
@@ -6292,7 +6296,8 @@ gtk_icon_view_set_margin (GtkIconView *icon_view,
  * gtk_icon_view_get_margin:
  * @icon_view: a #GtkIconView
  * 
- * Returns the value of the ::margin property.
+ * Returns the value of the ::margin property in pixels. To preserve the units
+ * use gtk_icon_view_get_margin_unit().
  * 
  * Return value: the space at the borders 
  *
@@ -6314,7 +6319,7 @@ gtk_icon_view_get_margin (GtkIconView *icon_view)
  * 
  * Return value: the space at the borders 
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_icon_view_get_margin_unit (GtkIconView *icon_view)
diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c
index 031f679..825e1a3 100644
--- a/gtk/gtkimage.c
+++ b/gtk/gtkimage.c
@@ -2321,6 +2321,7 @@ gtk_image_set_pixel_size (GtkImage *image,
  * @image: a #GtkImage
  * 
  * Gets the pixel size used for named icons.
+ * Use gtk_image_get_pixel_size_unit() to preserve units.
  *
  * Returns: the pixel size used for named icons.
  *
@@ -2344,9 +2345,9 @@ gtk_image_get_pixel_size (GtkImage *image)
  * 
  * Like gtk_image_get_pixel_size() but preserves the unit.
  *
- * Returns: the pixel size used for named icons.
+ * Returns: the size used for named icons.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_image_get_pixel_size_unit (GtkImage *image)
diff --git a/gtk/gtkmisc.c b/gtk/gtkmisc.c
index 2c97155..c1c4798 100644
--- a/gtk/gtkmisc.c
+++ b/gtk/gtkmisc.c
@@ -306,8 +306,10 @@ gtk_misc_set_padding (GtkMisc *misc,
  * @xpad: location to store padding in the X direction, or %NULL
  * @ypad: location to store padding in the Y direction, or %NULL
  *
- * Gets the padding in the X and Y directions of the widget. 
+ * Gets the padding (in pixels) in the X and Y directions of the widget. 
  * See gtk_misc_set_padding().
+ *
+ * Use gtk_misc_get_padding_unit() to preserve the units.
  **/
 void
 gtk_misc_get_padding (GtkMisc *misc,
@@ -334,7 +336,7 @@ gtk_misc_get_padding (GtkMisc *misc,
  *
  * Like gtk_misc_get_padding() but preserves the unit.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_misc_get_padding_unit (GtkMisc *misc,
diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index e98944e..4920f1f 100644
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -976,7 +976,7 @@ gtk_settings_class_init (GtkSettingsClass *class)
    * The ::unit-changed signal is emitted when unit conversion factors
    * on a screen change.
    *
-   * Since: 2.14
+   * Since: RIMERGE
    */
   signals[UNIT_CHANGED_SIGNAL] =
     g_signal_new (I_("unit-changed"),
diff --git a/gtk/gtksize.c b/gtk/gtksize.c
index d079fa2..c65f42e 100644
--- a/gtk/gtksize.c
+++ b/gtk/gtksize.c
@@ -567,7 +567,7 @@ screen_settings_get_pixel_conversion_factors (GdkScreen *screen,
  * need to enable it by default by calling this function before
  * invoking gtk_init().
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_enable_resolution_independence (void)
@@ -603,7 +603,7 @@ gtk_size_get_unit (GtkSize size)
  *
  * Returns: a #GtkSize
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_size_em (gdouble em)
@@ -631,7 +631,7 @@ gtk_size_em (gdouble em)
  *
  * Returns: a #GtkSize
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_size_mm (gdouble mm)
@@ -658,7 +658,7 @@ gtk_size_mm (gdouble mm)
  *
  * Returns: a #gdouble
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gdouble
 gtk_size_get_em (GtkSize size)
@@ -679,7 +679,7 @@ gtk_size_get_em (GtkSize size)
  *
  * Returns: a #gdouble
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gdouble
 gtk_size_get_mm (GtkSize size)
@@ -718,7 +718,7 @@ get_pixel_conversion_factors (GdkScreen *screen,
  *
  * Returns: @size converted to pixel value
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 gint
 gtk_size_to_pixel (GdkScreen *screen,
@@ -740,7 +740,7 @@ gtk_size_to_pixel (GdkScreen *screen,
  *
  * Returns: @size converted to pixel value
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 gdouble
 gtk_size_to_pixel_double (GdkScreen *screen,
@@ -796,7 +796,7 @@ gtk_size_to_pixel_double (GdkScreen *screen,
  *
  * Returns: the textual representation of @size - free with g_free().
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gchar *
 gtk_size_to_string (GtkSize size)
@@ -901,7 +901,7 @@ gtk_param_size_get_type (void)
  *
  * Returns: a newly created parameter specification
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GParamSpec *
 gtk_param_spec_size (const gchar *name,
@@ -935,7 +935,7 @@ gtk_param_spec_size (const gchar *name,
  * @v_size, the contents will be converted to pixel values using
  * gtk_widget_size_to_pixel() on @widget.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_value_set_size (GValue    *value,
@@ -957,7 +957,7 @@ gtk_value_set_size (GValue    *value,
  *
  * Returns: a #GtkSize
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_value_get_size (const GValue *value)
@@ -973,7 +973,7 @@ gtk_value_get_size (const GValue *value)
  * Specify that conversion to pixel values should be skipped in
  * gtk_value_set_size().
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_value_size_skip_conversion (GValue *value)
@@ -1053,7 +1053,7 @@ gtk_param_usize_get_type (void)
  *
  * Returns: a newly created parameter specification
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GParamSpec *
 gtk_param_spec_usize (const gchar *name,
@@ -1087,7 +1087,7 @@ gtk_param_spec_usize (const gchar *name,
  * @v_size, the contents will be converted to pixel values using
  * gtk_widget_size_to_pixel() on @widget.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_value_set_usize (GValue    *value,
@@ -1109,7 +1109,7 @@ gtk_value_set_usize (GValue    *value,
  *
  * Returns: a #GtkUSize
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkUSize
 gtk_value_get_usize (const GValue *value)
@@ -1125,7 +1125,7 @@ gtk_value_get_usize (const GValue *value)
  * Specify that conversion to pixel values should be skipped in
  * gtk_value_set_usize().
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_value_usize_skip_conversion (GValue *value)
diff --git a/gtk/gtksize.h b/gtk/gtksize.h
index 07c2b9c..39565e5 100644
--- a/gtk/gtksize.h
+++ b/gtk/gtksize.h
@@ -38,7 +38,7 @@ G_BEGIN_DECLS
  * (see gtk_enable_resolution_independence()). As such, a #GtkSize
  * cannot e.g. be stored on disk or passed to other processes.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 typedef gint GtkSize;
 
@@ -47,7 +47,7 @@ typedef gint GtkSize;
  *
  * Like #GtkSize but for unsigned sizes.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 typedef guint GtkUSize;
 
@@ -60,7 +60,7 @@ typedef guint GtkUSize;
  * The unit used to interpret the value stored in #GtkSize or
  * #GtkUSize. Use gtk_size_get_unit().
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 typedef enum
 {
@@ -76,7 +76,7 @@ typedef enum
  * units instead of pixel sizes, use this constant instead of G_MAXINT
  * when needing to specify a huge default for a bounded value.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 #define GTK_SIZE_MAXPIXEL ((1<<28) - 1)
 
@@ -87,7 +87,7 @@ typedef enum
  * units instead of pixel sizes, use this constant instead of G_MININT
  * when needing to specify a small default for a bounded value.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 #define GTK_SIZE_MINPIXEL (-GTK_SIZE_MAXPIXEL)
 
@@ -111,7 +111,7 @@ gchar      *gtk_size_to_string       (GtkSize      size);
  *
  * Error codes returned by size/unit parsing.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 typedef enum
 {
@@ -131,7 +131,7 @@ void gtk_enable_resolution_independence (void);
  * Convenience macro returning @value / 12 em's in a #GtkSize. See
  * gtk_unit_em() for details.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 #define GTK_SIZE_ONE_TWELFTH_EM(value) gtk_size_em((value)/12.0)
 
diff --git a/gtk/gtktable.c b/gtk/gtktable.c
index 77389a2..29630e0 100644
--- a/gtk/gtktable.c
+++ b/gtk/gtktable.c
@@ -820,8 +820,10 @@ gtk_table_set_row_spacing (GtkTable *table,
  * @table: a #GtkTable
  * @row: a row in the table, 0 indicates the first row
  *
- * Gets the amount of space between row @row, and
- * row @row + 1. See gtk_table_set_row_spacing().
+ * Gets the amount of space between row @row and
+ * row @row + 1 in pixels. See gtk_table_set_row_spacing().
+ *
+ * Use gtk_table_get_row_spacing_unit() to preserve units.
  *
  * Return value: the row spacing
  **/
@@ -846,7 +848,7 @@ gtk_table_get_row_spacing (GtkTable *table,
  *
  * Return value: the column spacing
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkUSize
 gtk_table_get_row_spacing_unit (GtkTable *table,
@@ -884,8 +886,10 @@ gtk_table_set_col_spacing (GtkTable *table,
  * @table: a #GtkTable
  * @column: a column in the table, 0 indicates the first column
  *
- * Gets the amount of space between column @col, and
- * column @col + 1. See gtk_table_set_col_spacing().
+ * Gets the amount of space between column @col and
+ * column @col + 1 in pixels. See gtk_table_set_col_spacing().
+ *
+ * Use gtk_table_get_col_spacing_unit() to preserve units.
  *
  * Return value: the column spacing
  **/
@@ -910,7 +914,7 @@ gtk_table_get_col_spacing (GtkTable *table,
  *
  * Return value: the column spacing
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkUSize
 gtk_table_get_col_spacing_unit (GtkTable *table,
@@ -952,10 +956,12 @@ gtk_table_set_row_spacings (GtkTable *table,
  * gtk_table_get_default_row_spacing:
  * @table: a #GtkTable
  *
- * Gets the default row spacing for the table. This is
+ * Gets the default row spacing for the table in pixels. This is
  * the spacing that will be used for newly added rows.
  * (See gtk_table_set_row_spacings())
  *
+ * Use gtk_table_get_default_row_spacing_unit() to preserve units.
+ *
  * Return value: the default row spacing
  **/
 guint
@@ -976,7 +982,7 @@ gtk_table_get_default_row_spacing (GtkTable *table)
  *
  * Return value: the default row spacing
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkUSize
 gtk_table_get_default_row_spacing_unit (GtkTable *table)
@@ -1020,10 +1026,12 @@ gtk_table_set_col_spacings (GtkTable *table,
  * gtk_table_get_default_col_spacing:
  * @table: a #GtkTable
  *
- * Gets the default column spacing for the table. This is
+ * Gets the default column spacing for the table in pixels. This is
  * the spacing that will be used for newly added columns.
  * (See gtk_table_set_col_spacings())
  *
+ * Use gtk_table_get_default_col_spacing_unit() to preserve units.
+ *
  * Return value: the default column spacing
  **/
 guint
@@ -1044,7 +1052,7 @@ gtk_table_get_default_col_spacing (GtkTable *table)
  *
  * Return value: the default column spacing
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkUSize
 gtk_table_get_default_col_spacing_unit (GtkTable *table)
diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c
index 51f1473..ceec38f 100644
--- a/gtk/gtktextview.c
+++ b/gtk/gtktextview.c
@@ -2357,8 +2357,13 @@ gtk_text_view_get_editable (GtkTextView *text_view)
  * @text_view: a #GtkTextView
  * @pixels_above_lines: pixels above paragraphs
  * 
- * Sets the default number of blank pixels above paragraphs in @text_view.
+ * Sets the default padding above paragraphs in @text_view.
  * Tags in the buffer for @text_view may override the defaults.
+ *
+ * <note>
+ * Although the method mentions pixels, this is simply for API compatibility.
+ * The measurement is actually a #GtkSize.
+ * </note>
  **/
 void
 gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
@@ -2384,7 +2389,8 @@ gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
  * gtk_text_view_get_pixels_above_lines:
  * @text_view: a #GtkTextView
  * 
- * Gets the default number of pixels to put above paragraphs.
+ * Gets the default number of pixels to put above paragraphs. To preserve the
+ * units use gtk_text_view_get_pixels_above_lines_unit().
  * 
  * Return value: default number of pixels above paragraphs
  **/
@@ -2401,10 +2407,15 @@ gtk_text_view_get_pixels_above_lines (GtkTextView *text_view)
  * @text_view: a #GtkTextView
  * 
  * Like gtk_text_view_get_pixels_above_lines() but preserves the unit.
+ *
+ * <note>
+ * Although the method mentions pixels, this is simply for API compatibility.
+ * The measurement is actually a #GtkSize.
+ * </note>
  * 
  * Return value: default number of pixels above paragraphs
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_text_view_get_pixels_above_lines_unit (GtkTextView *text_view)
@@ -2417,11 +2428,16 @@ gtk_text_view_get_pixels_above_lines_unit (GtkTextView *text_view)
 /**
  * gtk_text_view_set_pixels_below_lines:
  * @text_view: a #GtkTextView
- * @pixels_below_lines: pixels below paragraphs 
+ * @pixels_below_lines: padding below paragraphs
  *
- * Sets the default number of pixels of blank space
+ * Sets the default padding of blank space
  * to put below paragraphs in @text_view. May be overridden
- * by tags applied to @text_view's buffer. 
+ * by tags applied to @text_view's buffer.
+ *
+ * <note>
+ * Although the method mentions pixels, this is simply for API compatibility.
+ * The measurement is actually a #GtkSize.
+ * </note>
  **/
 void
 gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
@@ -2447,7 +2463,8 @@ gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
  * gtk_text_view_get_pixels_below_lines:
  * @text_view: a #GtkTextView
  * 
- * Gets the value set by gtk_text_view_set_pixels_below_lines().
+ * Gets the value set by gtk_text_view_set_pixels_below_lines() in pixels.
+ * To preserve the units use gtk_text_view_get_pixels_below_lines_unit().
  * 
  * Return value: default number of blank pixels below paragraphs
  **/
@@ -2464,10 +2481,15 @@ gtk_text_view_get_pixels_below_lines (GtkTextView *text_view)
  * @text_view: a #GtkTextView
  * 
  * Like gtk_text_view_get_pixels_below_lines() but preserves the unit.
+ *
+ * <note>
+ * Although the method mentions pixels, this is simply for API compatibility.
+ * The measurement is actually a #GtkSize.
+ * </note>
  * 
  * Return value: default number of blank pixels below paragraphs
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_text_view_get_pixels_below_lines_unit (GtkTextView *text_view)
@@ -2480,11 +2502,16 @@ gtk_text_view_get_pixels_below_lines_unit (GtkTextView *text_view)
 /**
  * gtk_text_view_set_pixels_inside_wrap:
  * @text_view: a #GtkTextView
- * @pixels_inside_wrap: default number of pixels between wrapped lines
+ * @pixels_inside_wrap: default padding between wrapped lines
  *
- * Sets the default number of pixels of blank space to leave between
+ * Sets the default padding of blank space to leave between
  * display/wrapped lines within a paragraph. May be overridden by
  * tags in @text_view's buffer.
+ *
+ * <note>
+ * Although the method mentions pixels, this is simply for API compatibility.
+ * The measurement is actually a #GtkSize.
+ * </note>
  **/
 void
 gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view,
@@ -2510,7 +2537,8 @@ gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view,
  * gtk_text_view_get_pixels_inside_wrap:
  * @text_view: a #GtkTextView
  * 
- * Gets the value set by gtk_text_view_set_pixels_inside_wrap().
+ * Gets the value set by gtk_text_view_set_pixels_inside_wrap() in pixels.
+ * Use gtk_text_view_get_pixels_inside_wrap_unit() to preserve units.
  * 
  * Return value: default number of pixels of blank space between wrapped lines
  **/
@@ -2527,10 +2555,15 @@ gtk_text_view_get_pixels_inside_wrap (GtkTextView *text_view)
  * @text_view: a #GtkTextView
  * 
  * Like gtk_text_view_get_pixels_inside_wrap() but preserves the unit.
+ *
+ * <note>
+ * Although the method mentions pixels, this is simply for API compatibility.
+ * The measurement is actually a #GtkSize.
+ * </note>
  * 
  * Return value: default number of pixels of blank space between wrapped lines
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_text_view_get_pixels_inside_wrap_unit (GtkTextView *text_view)
@@ -2589,7 +2622,7 @@ gtk_text_view_get_justification (GtkTextView *text_view)
 /**
  * gtk_text_view_set_left_margin:
  * @text_view: a #GtkTextView
- * @left_margin: left margin in pixels
+ * @left_margin: left margin padding
  * 
  * Sets the default left margin for text in @text_view.
  * Tags in the buffer may override the default.
@@ -2618,8 +2651,10 @@ gtk_text_view_set_left_margin (GtkTextView *text_view,
  * gtk_text_view_get_left_margin:
  * @text_view: a #GtkTextView
  * 
- * Gets the default left margin size of paragraphs in the @text_view.
+ * Gets the default left margin size of paragraphs in the @text_view in pixels.
  * Tags in the buffer may override the default.
+ *
+ * Use gtk_text_view_get_left_margin_unit() to preserve units.
  * 
  * Return value: left margin in pixels
  **/
@@ -2639,7 +2674,7 @@ gtk_text_view_get_left_margin (GtkTextView *text_view)
  * 
  * Return value: left margin in pixels
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_text_view_get_left_margin_unit (GtkTextView *text_view)
@@ -2652,7 +2687,7 @@ gtk_text_view_get_left_margin_unit (GtkTextView *text_view)
 /**
  * gtk_text_view_set_right_margin:
  * @text_view: a #GtkTextView
- * @right_margin: right margin in pixels
+ * @right_margin: right margin padding
  *
  * Sets the default right margin for text in the text view.
  * Tags in the buffer may override the default.
@@ -2681,8 +2716,9 @@ gtk_text_view_set_right_margin (GtkTextView *text_view,
  * gtk_text_view_get_right_margin:
  * @text_view: a #GtkTextView
  * 
- * Gets the default right margin for text in @text_view. Tags
+ * Gets the default right margin for text in @text_view in pixels. Tags
  * in the buffer may override the default.
+ * Use gtk_text_view_get_right_margin_unit() to preserve units.
  * 
  * Return value: right margin in pixels
  **/
@@ -2702,7 +2738,7 @@ gtk_text_view_get_right_margin (GtkTextView *text_view)
  * 
  * Return value: right margin in pixels
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_text_view_get_right_margin_unit (GtkTextView *text_view)
@@ -2715,7 +2751,7 @@ gtk_text_view_get_right_margin_unit (GtkTextView *text_view)
 /**
  * gtk_text_view_set_indent:
  * @text_view: a #GtkTextView
- * @indent: indentation in pixels
+ * @indent: indentation
  *
  * Sets the default indentation for paragraphs in @text_view.
  * Tags in the buffer may override the default.
@@ -2744,9 +2780,10 @@ gtk_text_view_set_indent (GtkTextView *text_view,
  * gtk_text_view_get_indent:
  * @text_view: a #GtkTextView
  * 
- * Gets the default indentation of paragraphs in @text_view.
+ * Gets the default indentation of paragraphs in @text_view in pixels.
  * Tags in the view's buffer may override the default.
  * The indentation may be negative.
+ * Use gtk_text_view_get_indent_unit() to preserve units.
  * 
  * Return value: number of pixels of indentation
  **/
@@ -2766,7 +2803,7 @@ gtk_text_view_get_indent (GtkTextView *text_view)
  * 
  * Return value: number of pixels of indentation
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_text_view_get_indent_unit (GtkTextView *text_view)
diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c
index d83e6d4..cce9925 100644
--- a/gtk/gtktreeview.c
+++ b/gtk/gtktreeview.c
@@ -15376,7 +15376,8 @@ gtk_tree_view_set_level_indentation (GtkTreeView *tree_view,
  * @tree_view: a #GtkTreeView.
  *
  * Returns the amount, in pixels, of extra indentation for child levels
- * in @tree_view.
+ * in @tree_view. To preserve the units use
+ * gtk_tree_view_get_level_indentation_unit().
  *
  * Return value: the amount of extra indentation for child levels in
  * @tree_view.  A return value of 0 means that this feature is disabled.
@@ -15400,7 +15401,7 @@ gtk_tree_view_get_level_indentation (GtkTreeView *tree_view)
  * Return value: the amount of extra indentation for child levels in
  * @tree_view.  A return value of 0 means that this feature is disabled.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 GtkSize
 gtk_tree_view_get_level_indentation_unit (GtkTreeView *tree_view)
diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index 015369c..04b05dc 100644
--- a/gtk/gtktreeviewcolumn.c
+++ b/gtk/gtktreeviewcolumn.c
@@ -1711,7 +1711,8 @@ gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
  * gtk_tree_view_column_get_spacing:
  * @tree_column: A #GtkTreeViewColumn.
  * 
- * Returns the spacing of @tree_column.
+ * Returns the spacing of @tree_column in pixels. To preserve the units
+ * use gtk_tree_view_column_get_spacing_unit().
  * 
  * Return value: the spacing of @tree_column.
  **/
@@ -1731,7 +1732,7 @@ gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
  * 
  * Return value: the spacing of @tree_column.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_tree_view_column_get_spacing_unit (GtkTreeViewColumn *tree_column)
@@ -1938,8 +1939,10 @@ gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
  * gtk_tree_view_column_get_fixed_width:
  * @tree_column: a #GtkTreeViewColumn
  * 
- * Gets the fixed width of the column.  This value is only meaning may not be
+ * Gets the fixed width of the column in pixels.  This value may not be
  * the actual width of the column on the screen, just what is requested.
+ *
+ * To preserve the units use gtk_tree_view_column_get_fixed_width_unit().
  * 
  * Return value: the fixed width of the column
  **/
@@ -1959,7 +1962,7 @@ gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
  * 
  * Return value: the fixed width of the column
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_tree_view_column_get_fixed_width_unit (GtkTreeViewColumn *tree_column)
@@ -2016,6 +2019,8 @@ gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
  * 
  * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
  * width is set.
+ *
+ * To preserve the units use gtk_tree_view_column_get_min_width_unit().
  * 
  * Return value: The minimum width of the @tree_column.
  **/
@@ -2035,7 +2040,7 @@ gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
  * 
  * Return value: The minimum width of the @tree_column.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_tree_view_column_get_min_width_unit (GtkTreeViewColumn *tree_column)
@@ -2094,6 +2099,8 @@ gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
  * 
  * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
  * width is set.
+ *
+ * To preserve the units use gtk_tree_view_column_get_max_width_unit()
  * 
  * Return value: The maximum width of the @tree_column.
  **/
@@ -2113,7 +2120,7 @@ gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
  * 
  * Return value: The maximum width of the @tree_column.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 GtkSize
 gtk_tree_view_column_get_max_width_unit (GtkTreeViewColumn *tree_column)
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index dceb7a8..a4e01da 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -1099,7 +1099,7 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    * The ::unit-changed signal is emitted when the units
    * change. @widget should recompute internal pixel sizes.
    *
-   * Since: 2.14
+   * Since: RIMERGE
    */
   widget_signals[UNIT_CHANGED] =
     g_signal_new (I_("unit_changed"),
@@ -7300,7 +7300,7 @@ gtk_widget_get_size_request (GtkWidget *widget,
  *
  * Like gtk_widget_get_size_request() but preserves the unit.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_widget_get_size_request_unit (GtkWidget *widget,
@@ -9318,7 +9318,7 @@ gtk_widget_style_get (GtkWidget   *widget,
  *
  * Like gtk_widget_style_get_property() but preserves units.
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 void
 gtk_widget_style_get_property_unit (GtkWidget   *widget,
@@ -9440,7 +9440,7 @@ gtk_widget_style_get_unit_valist (GtkWidget   *widget,
  * Like gtk_widget_stylet_get() but preserves all #GtkSize values
  * rather than using gtk_size_to_pixel().
  *
- * Since: 2.14
+ * Since: RIMERGE
  */
 void
 gtk_widget_style_get_unit (GtkWidget   *widget,
@@ -10860,7 +10860,7 @@ gtk_widget_get_unit_valist (GtkWidget *widget,
  * Like g_object_get() but preserves the unit for properties of type
  * #GtkSize and #GtkUSize.
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 void
 gtk_widget_get_unit (gpointer widget,
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index 3293917..b61d91f 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -792,7 +792,7 @@ gtk_window_class_init (GtkWindowClass *klass)
    * The monitor number for which the largest area of the window
    * resides. -1 if window is not realized.
    *
-   * Since: 2.14
+   * Since: RIMERGE
    */
   g_object_class_install_property (gobject_class,
 				   PROP_MONITOR_NUM,
@@ -8594,7 +8594,7 @@ gtk_window_set_default_icon_from_file (const gchar *filename,
  *
  * Returns: the monitor number
  *
- * Since: 2.14
+ * Since: RIMERGE
  **/
 gint
 gtk_window_get_monitor_num (GtkWindow *window)
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]