GNOME.org
 

[gtk+/wip/baedert/gtkimageview: 184/185] Docs

commit 64c0c0a0813698b9bf8acbebe736df962b7e9aff
Author: Timm Bäder <mail baedert org>
Date:   Tue Feb 9 10:32:56 2016 +0100

    Docs

 docs/reference/gtk/gtk-docs.sgml     |    1 +
 docs/reference/gtk/gtk3-sections.txt |    7 ----
 docs/reference/gtk/visual_index.xml  |    3 ++
 gtk/gtkimageview.c                   |   51 ++++++++++++++++++++++-----------
 4 files changed, 38 insertions(+), 24 deletions(-)
---
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index f290973..862171d 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -93,6 +93,7 @@
       <title>Display Widgets</title>
       <xi:include href="xml/gtklabel.xml" />
       <xi:include href="xml/gtkimage.xml" />
+      <xi:include href="xml/gtkimageview.xml" />
       <xi:include href="xml/gtkspinner.xml" />
       <xi:include href="xml/gtkinfobar.xml" />
       <xi:include href="xml/gtkprogressbar.xml" />
diff --git a/docs/reference/gtk/gtk3-sections.txt b/docs/reference/gtk/gtk3-sections.txt
index c92d5cd..af308cb 100644
--- a/docs/reference/gtk/gtk3-sections.txt
+++ b/docs/reference/gtk/gtk3-sections.txt
@@ -1999,8 +1999,6 @@ GtkImageIconNameData
 GtkImageGIconData
 </SECTION>
 
-
-
 <SECTION>
 <FILE>gtkimageview</FILE>
 <TITLE>GtkImageView</TITLE>
@@ -2037,11 +2035,6 @@ GtkImageViewPrivate
 gtk_image_view_get_type
 </SECTION>
 
-
-
-
-
-
 <SECTION>
 <FILE>gtkimagemenuitem</FILE>
 <TITLE>GtkImageMenuItem</TITLE>
diff --git a/docs/reference/gtk/visual_index.xml b/docs/reference/gtk/visual_index.xml
index c3f3776..439589e 100644
--- a/docs/reference/gtk/visual_index.xml
+++ b/docs/reference/gtk/visual_index.xml
@@ -33,6 +33,9 @@
     <link linkend="GtkImage">
       <inlinegraphic fileref="image.png" format="PNG"></inlinegraphic>
     </link>
+    <link linkend="GtkImageView">
+      <inlinegraphic fileref="image.png" format="PNG"></inlinegraphic>
+    </link>
     <link linkend="GtkSeparator">
       <inlinegraphic fileref="separator.png" format="PNG"></inlinegraphic>
     </link>
diff --git a/gtk/gtkimageview.c b/gtk/gtkimageview.c
index 8926e32..5cb4e48 100644
--- a/gtk/gtkimageview.c
+++ b/gtk/gtkimageview.c
@@ -17,10 +17,11 @@
 
 /**
  * SECTION:gtkimageview
- * @Short_description: A widget.
+ * @Short_description: A widget for displaying content images to users.
  * @Title: GtkImageView
  *
  *
+ *
  * Since: 3.20
  */
 
@@ -1243,13 +1244,13 @@ gtk_image_view_set_vscroll_policy (GtkImageView        *image_view,
  * Sets the value of the #scale property. This will cause the
  * #scale-set property to be set to #FALSE as well
  *
- * If #GtkImageView:fit-allocation is %TRUE, it will be set to #FALSE, and @image_view
+ * If #GtkImageView:fit-allocation is %TRUE, it will be set to %FALSE, and @image_view
  * will be resized to the image's current size, taking the new scale into
  * account.
  *
- * If #GtkImageView:transitions-enabled is set to #TRUE, the internal scale value will be
- * interpolated between the old and the new scale, #gtk_image_view_get_scale
- * will report the one passed to #gtk_image_view_set_scale however.
+ * If #GtkImageView:transitions-enabled is set to %TRUE, the internal scale value will be
+ * interpolated between the old and the new scale, gtk_image_view_get_scale()
+ * will report the one passed to gtk_image_view_set_scale() however.
  *
  * Since: 3.20
  */
@@ -1466,13 +1467,13 @@ gtk_image_view_get_snap_angle (GtkImageView *image_view)
  * @image_view: A #GtkImageView instance
  * @fit_allocation: The new value of the #fit-allocation property.
  *
- * Setting #fit-allocation to #TRUE will cause the image to be scaled
+ * Setting #GtkImageView:fit-allocation to %TRUE will cause the image to be scaled
  * to the widget's allocation, unless it would cause the image to be
  * scaled up.
  *
- * Setting #fit-allocation will have the side effect of setting
+ * Setting #GtkImageView:fit-allocation will have the side effect of setting
  * #scale-set set to %FALSE, thus giving the #GtkImageView the control
- * over the image's scale. Additionally, if the new #fit-allocation
+ * over the image's scale. Additionally, if the new #GtkImageView:fit-allocation
  * value is %FALSE, the scale will be reset to 1.0 and the #GtkImageView
  * will be resized to take at least the image's real size.
  *
@@ -1515,7 +1516,7 @@ gtk_image_view_set_fit_allocation (GtkImageView *image_view,
  * gtk_image_view_get_fit_allocation:
  * @image_view: A #GtkImageView instance
  *
- * Returns: The current value of the #fit-allocation property.
+ * Returns: The current value of the #GtkImageView:fit-allocation property.
  *
  * Since: 3.20
  */
@@ -1533,7 +1534,7 @@ gtk_image_view_get_fit_allocation (GtkImageView *image_view)
  * @image_view: A #GtkImageView instance
  * @rotatable: The new value of the rotatable property
  *
- * Sets the value of the #rotatable property to @rotatable. This controls whether
+ * Sets the value of the #GtkImageView:rotatable property to @rotatable. This controls whether
  * the user can change the angle of the displayed image using a two-finger gesture.
  *
  * Since: 3.20
@@ -1560,7 +1561,7 @@ gtk_image_view_set_rotatable (GtkImageView *image_view,
  * gtk_image_view_get_rotatable:
  * @image_view: A #GtkImageView instance
  *
- * Returns: The current value of the #rotatable property
+ * Returns: The current value of the #GtkImageView:rotatable property
  *
  * Since: 3.20
  */
@@ -1578,7 +1579,7 @@ gtk_image_view_get_rotatable (GtkImageView *image_view)
  * @image_view: A #GtkImageView instance
  * @zoomable: The new value of the #zoomable property
  *
- * Sets the new value of the #zoomable property. This controls whether the user can
+ * Sets the new value of the #GtkImageView:zoomable property. This controls whether the user can
  * change the #GtkImageView:scale property using a two-finger gesture.
  *
  * Since: 3.20
@@ -1619,7 +1620,7 @@ gtk_image_view_get_zoomable (GtkImageView *image_view)
 }
 
 /**
- * gtk_image_view_set_transiions_enabled:
+ * gtk_image_view_set_transitions_enabled:
  * @image_view: A #GtkImageView instance
  * @transitions_enabled: The new value of the #transitions-enabled property
  *
@@ -2049,7 +2050,7 @@ gtk_image_view_class_init (GtkImageViewClass *view_class)
                                                        GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
 /**
    * GtkImageView:zoomable:
-   * Whether or not image can be scaled using a two-finger zoom gesture.
+   * Whether or not the image can be scaled using a two-finger zoom gesture.
    *
    * Since: 3.20
    */
@@ -2117,6 +2118,8 @@ gtk_image_view_class_init (GtkImageViewClass *view_class)
  * gtk_image_view_new:
  *
  * Returns: A newly created #GtkImageView instance.
+ *
+ * Since: 3.20
  */
 GtkWidget *
 gtk_image_view_new ()
@@ -2329,6 +2332,8 @@ gtk_image_view_load_from_input_stream (GTask        *task,
  * @user_data: (closure): Data to pass to @callback
  *
  * Asynchronously loads an image from the given file.
+ *
+ * Since: 3.20
  */
 void
 gtk_image_view_load_from_file_async (GtkImageView        *image_view,
@@ -2362,6 +2367,8 @@ gtk_image_view_load_from_file_async (GtkImageView        *image_view,
  * @error: (nullable): Location to store error information in case the operation fails
  *
  * Returns: %TRUE if the operation succeeded, %FALSE otherwise.
+ *
+ * Since: 3.20
  */
 gboolean
 gtk_image_view_load_from_file_finish   (GtkImageView  *image_view,
@@ -2378,11 +2385,13 @@ gtk_image_view_load_from_file_finish   (GtkImageView  *image_view,
  * @image_view: A #GtkImageView instance
  * @input_stream: (transfer full): Input stream to read from
  * @scale_factor: The scale factor of the read image
- * @cancellable: (nullable): The GCancellable used to cancel the operation
+ * @cancellable: (nullable): The #GCancellable used to cancel the operation
  * @callback: (scope async): A #GAsyncReadyCallback invoked when the operation finishes
  * @user_data: (closure): The data to pass to @callback
  *
  * Asynchronously loads an image from the given input stream.
+ *
+ * Since: 3.20
  */
 void
 gtk_image_view_load_from_stream_async (GtkImageView        *image_view,
@@ -2416,6 +2425,8 @@ gtk_image_view_load_from_stream_async (GtkImageView        *image_view,
  * @error: (nullable): Location to store error information on failure
  *
  * Returns: %TRUE if the operation finished successfully, %FALSE otherwise.
+ *
+ * Since: 3.20
  */
 gboolean
 gtk_image_view_load_from_stream_finish (GtkImageView  *image_view,
@@ -2427,7 +2438,7 @@ gtk_image_view_load_from_stream_finish (GtkImageView  *image_view,
   return g_task_propagate_boolean (G_TASK (result), error);
 }
 
-/*
+/**
  * gtk_image_view_set_pixbuf:
  * @image_view: A #GtkImageView instance
  * @pixbuf: (transfer none): A #GdkPixbuf instance
@@ -2436,6 +2447,8 @@ gtk_image_view_load_from_stream_finish (GtkImageView  *image_view,
  *   with the given scale factor", i.e. if the pixbuf's scale
  *   factor is 2, and the screen's scale factor is also 2, the
  *   pixbuf won't be scaled up.
+ *
+ * Since: 3.20
  */
 void
 gtk_image_view_set_pixbuf (GtkImageView    *image_view,
@@ -2464,9 +2477,11 @@ gtk_image_view_set_pixbuf (GtkImageView    *image_view,
 /**
  * gtk_image_view_set_surface:
  * @image_view: A #GtkImageView instance
- * @surface: (nullable) (transfer full): A #cairo_surface_t of type #CAIRO_SURFACE_TYPE_IMAGE, or
+ * @surface: (nullable) (transfer full): A #cairo_surface_t of type %CAIRO_SURFACE_TYPE_IMAGE, or
  *   %NULL to unset any internal image data. In case this is %NULL, the scale will
  *   be reset to 1.0.
+ *
+ * Since: 3.20
  */
 void
 gtk_image_view_set_surface (GtkImageView    *image_view,
@@ -2526,6 +2541,8 @@ gtk_image_view_set_surface (GtkImageView    *image_view,
  *   with the given scale factor", i.e. if the animation's scale
  *   factor is 2, and the screen's scale factor is also 2, the
  *   animation won't be scaled up.
+ *
+ * Since: 3.20
  */
 void
 gtk_image_view_set_animation (GtkImageView       *image_view,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]