[eog] Add some API docs to EogScrollView's enum types



commit 3fd1cbb9910af433100d8d4b120158a7c8fc2784
Author: Felix Riemann <friemann gnome org>
Date:   Sun Jan 2 20:00:53 2011 +0100

    Add some API docs to EogScrollView's enum types

 src/eog-scroll-view.c |    2 +-
 src/eog-scroll-view.h |   19 +++++++++++++++++++
 2 files changed, 20 insertions(+), 1 deletions(-)
---
diff --git a/src/eog-scroll-view.c b/src/eog-scroll-view.c
index 240f8d1..750d217 100644
--- a/src/eog-scroll-view.c
+++ b/src/eog-scroll-view.c
@@ -2743,7 +2743,7 @@ eog_scroll_view_class_init (EogScrollViewClass *klass)
 	 * EogScrollView:transparency-color:
 	 *
 	 * This is the color used to fill the transparent parts of an image
-	 * if :transparency-style is set to use a custom color.
+	 * if #EogScrollView:transparency-style is set to %EOG_TRANSP_COLOR.
 	 */
 	g_object_class_install_property (
 		gobject_class, PROP_TRANSP_COLOR,
diff --git a/src/eog-scroll-view.h b/src/eog-scroll-view.h
index b1f4a67..09b0b2e 100644
--- a/src/eog-scroll-view.h
+++ b/src/eog-scroll-view.h
@@ -29,12 +29,31 @@ struct _EogScrollViewClass {
 	void (* zoom_changed) (EogScrollView *view, double zoom);
 };
 
+/**
+ * EogTransparencyStyle:
+ * @EOG_TRANSP_BACKGROUND: Use the background color of the current UI theme
+ * @EOG_TRANSP_CHECKED: Show transparent parts as a checkerboard pattern
+ * @EOG_TRANSP_COLOR: Show transparent parts in a user defined color
+ *                    (see #EogScrollView:transparency-color )
+ *
+ * Used to define how transparent image parts are drawn.
+ */
 typedef enum {
 	EOG_TRANSP_BACKGROUND,
 	EOG_TRANSP_CHECKED,
 	EOG_TRANSP_COLOR
 } EogTransparencyStyle;
 
+/**
+ * EogZoomMode:
+ * @EOG_ZOOM_MODE_FREE: Use the currently set zoom factor to display the image
+ *                      (see eog_scroll_view_set_zoom()).
+ * @EOG_ZOOM_MODE_SHRINK_TO_FIT: If an image is to large for the window,
+ *                               zoom out until the image is fully visible.
+ *                               This will never zoom in on smaller images.
+ *
+ * Used to determine the zooming behaviour of an #EogScrollView.
+ */
 typedef enum {
 	EOG_ZOOM_MODE_FREE,
 	EOG_ZOOM_MODE_SHRINK_TO_FIT



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]