gtype: Document type for iface_default_init() function

And mention why it’s not a GInterfaceInitFunc as people who have read
the GObject docs cover-to-cover might expect.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall 2018-12-27 23:46:42 +00:00
parent db0bce02cb
commit 154b24c055

View File

@ -1753,6 +1753,12 @@ guint g_type_get_type_registration_serial (void);
* name `t_n ## _default_init`, and the interface structure to have the * name `t_n ## _default_init`, and the interface structure to have the
* name `TN ## Interface`. * name `TN ## Interface`.
* *
* The initialization function has signature
* `static void t_n ## _default_init (TypeName##Interface *klass);`, rather than
* the full #GInterfaceInitFunc signature, for brevity and convenience. If you
* need to use an initialization function with an `iface_data` argument, you
* must write the #GTypeInterface definitions manually.
*
* Since: 2.24 * Since: 2.24
*/ */
#define G_DEFINE_INTERFACE(TN, t_n, T_P) G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, ;) #define G_DEFINE_INTERFACE(TN, t_n, T_P) G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, ;)