[gtksourceview/wip/gutter: 5/5] Gutter: improve doc
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtksourceview/wip/gutter: 5/5] Gutter: improve doc
- Date: Wed, 4 Sep 2013 15:17:41 +0000 (UTC)
commit 02ee33f3568594a98ec668971db804d34d7171b7
Author: Sébastien Wilmet <swilmet gnome org>
Date: Wed Sep 4 17:01:26 2013 +0200
Gutter: improve doc
gtksourceview/gtksourcegutterrenderer.c | 23 +++++++++++++++++++----
1 files changed, 19 insertions(+), 4 deletions(-)
---
diff --git a/gtksourceview/gtksourcegutterrenderer.c b/gtksourceview/gtksourcegutterrenderer.c
index c080b0e..432280f 100644
--- a/gtksourceview/gtksourcegutterrenderer.c
+++ b/gtksourceview/gtksourcegutterrenderer.c
@@ -25,6 +25,17 @@
#include "gtksourceview-typebuiltins.h"
#include "gtksourceview-i18n.h"
+/**
+ * SECTION:gutterrenderer
+ * @Short_description: Gutter cell renderer
+ * @Title: GtkSourceGutterRenderer
+ * @See_also: #GtkSourceGutter
+ *
+ * The total width of a renderer in a gutter is its size
+ * (#GtkSourceGutterRenderer:size) plus two times the horizontal padding
+ * (#GtkSourceGutterRenderer:xpad).
+ */
+
enum
{
ACTIVATE,
@@ -473,7 +484,7 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:xpad:
*
- * The x-padding of the renderer.
+ * The left and right padding of the renderer.
*
**/
g_object_class_install_property (object_class,
@@ -489,7 +500,7 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:ypad:
*
- * The y-padding of the renderer.
+ * The top and bottom padding of the renderer.
*
**/
g_object_class_install_property (object_class,
@@ -505,7 +516,9 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:xalign:
*
- * The x-alignment of the renderer.
+ * The horizontal alignment of the renderer. Set to 0 for a left
+ * alignment. 1 for a right alignment. And 0.5 for centering the cells.
+ * A value lower than 0 doesn't modify the alignment.
*
**/
g_object_class_install_property (object_class,
@@ -521,7 +534,9 @@ gtk_source_gutter_renderer_class_init (GtkSourceGutterRendererClass *klass)
/**
* GtkSourceGutterRenderer:yalign:
*
- * The y-alignment of the renderer.
+ * The vertical alignment of the renderer. Set to 0 for a top
+ * alignment. 1 for a bottom alignment. And 0.5 for centering the cells.
+ * A value lower than 0 doesn't modify the alignment.
*
**/
g_object_class_install_property (object_class,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]