Commit 7eadf458 authored by Javier Jardón's avatar Javier Jardón

gtktypeutils: move documentation to inline comments

parent a47e5483
......@@ -34,4 +34,5 @@ gtktextiter.sgml
gtktoggleaction.sgml
gtktoolitem.sgml
gtktreednd.sgml
gtktypeutils.sgml
gtkwindow.sgml
<!-- ##### SECTION Title ##### -->
Types
<!-- ##### SECTION Short_Description ##### -->
Handle run-time type creation
<!-- ##### SECTION Long_Description ##### -->
<para>
The GTK+ type system is extensible. Because of that, types have to be
managed at runtime.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### USER_FUNCTION GtkFunction ##### -->
<para>
Defines a function pointer.
</para>
@data: #gpointer
@Returns: #gint
<!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
<para>
Defines a function pointer.
</para>
@object: #GtkObject*
@data: #gpointer
@n_args: #guint
@args: #GtkArg*
<!-- ##### STRUCT GtkArg ##### -->
<para>
This is a structure that we use to pass in typed values (and names).
</para>
@type:
@name:
......@@ -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)
{
......
......@@ -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;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment