diff options
author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-10-10 22:21:18 +0200 |
---|---|---|
committer | Colin Walters <walters@verbum.org> | 2013-10-10 16:48:51 -0400 |
commit | a737daa16e458e87f189c2535f11f4bd2dde8f1a (patch) | |
tree | aeafe6e33e0009a261262219f2286aab248a2ae6 /girepository/girffi.c | |
parent | 3c01854fe58c845956bc8f08e9bd9fd9929b6f8d (diff) | |
download | gobject-introspection-a737daa16e458e87f189c2535f11f4bd2dde8f1a.tar.gz |
docs: fix up reference docs a bit
- require GTK-Doc 1.19
- remove sgml mode
- automatically generate gi.types (needs GTK-Doc 1.19)
- fix https://bugzilla.gnome.org/show_bug.cgi?id=700025
[WIP] - rearange sections a bit
[WIP] - add gi-building, gi-programming sections
[WIP] - mark missing docs with TODO, which is only marginaly
better than nothing but at least can be grepped :)
https://bugzilla.gnome.org/show_bug.cgi?id=571648
Diffstat (limited to 'girepository/girffi.c')
-rw-r--r-- | girepository/girffi.c | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/girepository/girffi.c b/girepository/girffi.c index f4c80eaa..30642fe1 100644 --- a/girepository/girffi.c +++ b/girepository/girffi.c @@ -33,6 +33,14 @@ #include "girepository.h" #include "girepository-private.h" +/** + * SECTION:girffi + * @short_description: TODO + * @title: girffi + * + * TODO + */ + static ffi_type * gi_type_tag_get_ffi_type_internal (GITypeTag tag, gboolean is_pointer, @@ -103,22 +111,26 @@ gi_type_tag_get_ffi_type_internal (GITypeTag tag, /** * gi_type_tag_get_ffi_type: - * @tag: A #GITypeTag + * @type_tag: A #GITypeTag * @is_pointer: Whether or not this is a pointer type * + * TODO + * * Returns: A #ffi_type corresponding to the platform default C ABI for @tag and @is_pointer. */ ffi_type * -gi_type_tag_get_ffi_type (GITypeTag tag, +gi_type_tag_get_ffi_type (GITypeTag type_tag, gboolean is_pointer) { - return gi_type_tag_get_ffi_type_internal (tag, is_pointer, FALSE); + return gi_type_tag_get_ffi_type_internal (type_tag, is_pointer, FALSE); } /** * g_type_info_get_ffi_type: * @info: A #GITypeInfo * + * TODO + * * Returns: A #ffi_type corresponding to the platform default C ABI for @info. */ ffi_type * @@ -150,7 +162,9 @@ g_type_info_get_ffi_type (GITypeInfo *info) * @callable_info: a callable info from a typelib * @n_args_p: (out): The number of arguments * - * Return value: an array of ffi_type*. The array itself + * TODO + * + * Returns: an array of ffi_type*. The array itself * should be freed using g_free() after use. */ static ffi_type ** @@ -217,7 +231,8 @@ g_callable_info_get_ffi_arg_types (GICallableInfo *callable_info, * * Fetches the ffi_type for a corresponding return value of * a #GICallableInfo - * Return value: the ffi_type for the return value + * + * Returns: the ffi_type for the return value */ static ffi_type * g_callable_info_get_ffi_return_type (GICallableInfo *callable_info) @@ -316,7 +331,7 @@ g_function_invoker_new_for_address (gpointer addr, } /** - * g_function_info_invoker_destroy: + * g_function_invoker_destroy: * @invoker: A #GIFunctionInvoker * * Release all resources allocated for the internals of @invoker; callers @@ -343,8 +358,8 @@ typedef struct { * * Prepares a callback for ffi invocation. * - * Return value: the ffi_closure or NULL on error. - * The return value should be freed by calling g_callable_info_free_closure(). + * Returns: the ffi_closure or NULL on error. The return value + * should be freed by calling g_callable_info_free_closure(). */ ffi_closure * g_callable_info_prepare_closure (GICallableInfo *callable_info, |