[gtk+] Move documentation to inline comments: GtkStyle



commit 885b6d8a75fe2d2b98e71c9f86b39cedb5ba369d
Author: Javier Jardón <jjardon gnome org>
Date:   Sun May 16 00:44:58 2010 +0200

    Move documentation to inline comments: GtkStyle

 docs/reference/gtk/tmpl/.gitignore    |    1 +
 docs/reference/gtk/tmpl/gtkstyle.sgml |  647 ---------------------------------
 gtk/gtkstyle.c                        |   20 +
 gtk/gtkstyle.h                        |   16 +
 4 files changed, 37 insertions(+), 647 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index d1700d0..c4ff36f 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -11,6 +11,7 @@ gtkrecentaction.sgml
 gtkscalebutton.sgml
 gtkseparator.sgml
 gtkseparatormenuitem.sgml
+gtkstyle.sgml
 gtktesting.sgml
 gtktextiter.sgml
 gtktoggleaction.sgml
diff --git a/gtk/gtkstyle.c b/gtk/gtkstyle.c
index 53c4711..8a1c8cc 100644
--- a/gtk/gtkstyle.c
+++ b/gtk/gtkstyle.c
@@ -43,6 +43,26 @@
 #include "gtkalias.h"
 #include "gtkspinner.h"
 
+
+/**
+ * SECTION:gtkstyle
+ * @Short_description: An object that hold style information for widgets
+ * @Title: GtkStyle
+ *
+ * A #GtkStyle object encapsulates the information that provides the look and
+ * feel for a widget. Each #GtkWidget has an associated #GTkStyle object that
+ * is used when rendering that widget. Also, a #GtkStyle holds information for
+ * the five possible widget states though not every widget supports all five
+ * states; see #GtkStateType.
+ *
+ * Usually the #GtkStyle for a widget is the same as the default style that is
+ * set by GTK+ and modified the theme engine.
+ *
+ * Usually applications should not need to use or modify the #GtkStyle of their
+ * widgets.
+ */
+
+
 #define LIGHTNESS_MULT  1.3
 #define DARKNESS_MULT   0.7
 
diff --git a/gtk/gtkstyle.h b/gtk/gtkstyle.h
index 141cbcc..dd88900 100644
--- a/gtk/gtkstyle.h
+++ b/gtk/gtkstyle.h
@@ -68,6 +68,12 @@ typedef gboolean (*GtkRcPropertyParser) (const GParamSpec *pspec,
  */
 typedef struct _GtkWidget      GtkWidget;
 
+/**
+ * GTK_STYLE_ATTACHED:
+ * @style: a #GtkStyle.
+ *
+ * Returns whether the style is attached to a window.
+ */
 #define GTK_STYLE_ATTACHED(style)	(GTK_STYLE (style)->attach_count > 0)
 
 struct _GtkStyle
@@ -429,6 +435,16 @@ struct _GtkStyleClass
   void (*_gtk_reserved11) (void);
 };
 
+/**
+ * GtkBorder:
+ * @left: The width of the left border.
+ * @right: The width of the right border.
+ * @top: The width of the top border.
+ * @bottom: The width of the bottom border.
+ *
+ * A struct that specifies a border around a rectangular area that can
+ * be of different width on each side.
+ */
 struct _GtkBorder
 {
   gint left;



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