[gtk+] gtktypeutils: move documentation to inline comments



commit 7eadf458886588448c2615e1cf74668431e331f7
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Sep 1 19:36:19 2010 +0200

    gtktypeutils: move documentation to inline comments

 docs/reference/gtk/tmpl/.gitignore        |    1 +
 docs/reference/gtk/tmpl/gtktypeutils.sgml |   51 -----------------------------
 gtk/gtktypeutils.c                        |   10 ++++++
 gtk/gtktypeutils.h                        |   25 +++++++++++++-
 4 files changed, 35 insertions(+), 52 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index d19042e..c9a1746 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -34,4 +34,5 @@ gtktextiter.sgml
 gtktoggleaction.sgml
 gtktoolitem.sgml
 gtktreednd.sgml
+gtktypeutils.sgml
 gtkwindow.sgml
diff --git a/gtk/gtktypeutils.c b/gtk/gtktypeutils.c
index 1d6f9b4..ea30f06 100644
--- a/gtk/gtktypeutils.c
+++ b/gtk/gtktypeutils.c
@@ -32,6 +32,16 @@
 #include "gtkintl.h"
 
 
+/**
+ * SECTION:gtktypeutils
+ * @Short_description: Handle run-time type creation
+ * @Title: Types
+ *
+ * The GTK+ type system is extensible.  Because of that, types have to be
+ * managed at runtime.
+ */
+
+
 GType
 gtk_identifier_get_type (void)
 {
diff --git a/gtk/gtktypeutils.h b/gtk/gtktypeutils.h
index 75711a3..883266e 100644
--- a/gtk/gtktypeutils.h
+++ b/gtk/gtktypeutils.h
@@ -47,7 +47,26 @@ GType gtk_identifier_get_type (void) G_GNUC_CONST;
  */
 typedef struct _GtkArg	       	     GtkArg;
 typedef struct _GtkObject   	     GtkObject; /* object forward declaration */
+
+/**
+ * GtkFunction:
+ * @data: #gpointer
+ *
+ * Defines a function pointer.
+ *
+ * Returns: #gint
+ */
 typedef gboolean (*GtkFunction)	    (gpointer      data);
+
+/**
+ * GtkCallbackMarshal:
+ * @object: #GtkObject*
+ * @data: #gpointer
+ * @n_args: #guint
+ * @args: #GtkArg*
+ *
+ * Defines a function pointer.
+ */
 typedef void (*GtkCallbackMarshal)  (GtkObject    *object,
 				     gpointer      data,
 				     guint         n_args,
@@ -60,7 +79,11 @@ typedef gchar * (*GtkTranslateFunc) (const gchar  *path,
 				     gpointer      func_data);
 
 #if defined (GTK_COMPILATION)
-/* GtkArg, used to hold differently typed values */
+/**
+ * GtkArg:
+ *
+ * This is a structure that we use to pass in typed values (and names).
+ */
 struct _GtkArg
 {
   GType type;



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