GtkdocIface

GtkdocIface — interface for gtk-doc unit test

Synopsis

                    GtkdocIface;
                    GtkdocIfaceInterface;
gboolean            gtkdoc_iface_configure              (gchar *config);
#define             GTKDOC_IFACE_MACRO_DUMMY            (parameter_1,parameter_2)
#define             GTKDOC_IFACE_MACRO_SUM              (parameter_1,parameter_2)

Object Hierarchy

  GInterface
   +----GtkdocIface

Properties

  "itest"                    gchar*                : Read / Write

Signals

  "itest"                                          : Run Last / No Recursion / No Hooks

Description

This file contains non-sense code for the sole purpose of testing the docs. We can link to the "itest" property and the "itest" signal. An instance can be configured using the gtkdoc_iface_configure() function.

Details

GtkdocIface

typedef struct _GtkdocIface GtkdocIface;

opaque instance of gtk-doc unit test interface


GtkdocIfaceInterface

typedef struct {
  GTypeInterface parent;

  /* class methods */
  void (*test)(const GtkdocIface * const self, gconstpointer const user_data);
} GtkdocIfaceInterface;

class data of gtk-doc unit test interface

GTypeInterface parent;

this is a bug :/

test ()

overideable method

gtkdoc_iface_configure ()

gboolean            gtkdoc_iface_configure              (gchar *config);

Configure a new instance

config :

settings

Returns :

TRUE for sucess or FALSE in case of an error

Since 0.1


GTKDOC_IFACE_MACRO_DUMMY()

#define GTKDOC_IFACE_MACRO_DUMMY(parameter_1,parameter_2) /* do nothing */

This macro does nothing.

parameter_1 :

first arg

parameter_2 :

second arg

GTKDOC_IFACE_MACRO_SUM()

#define             GTKDOC_IFACE_MACRO_SUM(parameter_1,parameter_2)

This macro adds its args.

Return: the sum of parameter_1 and parameter_2

parameter_1 :

first arg

parameter_2 :

second arg

Property Details

The "itest" property

  "itest"                    gchar*                : Read / Write

dummy property for iface.

Default value: "dummy"

Signal Details

The "itest" signal

void                user_function                      (GtkdocIface *self,
                                                        gpointer     user_data)      : Run Last / No Recursion / No Hooks

The event has been triggered.

self :

myself

user_data :

user data set when the signal handler was connected.