Skip to content
Snippets Groups Projects
Commit cda04efe authored by Simon McVittie's avatar Simon McVittie Committed by Vivek Das Mohapatra
Browse files

docs: Clarify calling conventions


Nobody is ever going to use this library via gobject-introspection
(we hope), but its annotations are as good a pattern as any other
and gtk-doc presents them nicely, so we might as well use them for
documentation.

Signed-off-by: default avatarSimon McVittie <smcv@collabora.com>
parent 8e7d982e
Branches
Tags
1 merge request!311Build capsule-capture-libs from a bundled copy of libcapsule
...@@ -165,6 +165,11 @@ excluded_from_wrap (const char *name, char **exclude) ...@@ -165,6 +165,11 @@ excluded_from_wrap (const char *name, char **exclude)
return 0; return 0;
} }
/*
* @exclude: (array zero-terminated=1): same as for capsule_dlmopen()
* @errcode: (out): errno
* @error: (out) (transfer full) (optional): Error string
*/
// replace calls out to dlopen in the encapsulated DSO with a wrapper // replace calls out to dlopen in the encapsulated DSO with a wrapper
// which should take care of preserving the /path-prefix and namespace // which should take care of preserving the /path-prefix and namespace
// wrapping of the original capsule_dlmopen() call. // wrapping of the original capsule_dlmopen() call.
......
...@@ -74,8 +74,12 @@ void capsule_init (void); ...@@ -74,8 +74,12 @@ void capsule_init (void);
* @target: The DSO from which to export symbols (currently unused) * @target: The DSO from which to export symbols (currently unused)
* @source: The dl handle from which to export symbols * @source: The dl handle from which to export symbols
* @debug: Internal debug flag. Pass 0 here. * @debug: Internal debug flag. Pass 0 here.
* @relocations: Array of capsule_item specifying which symbols to export * @relocations: (array zero-terminated=1): Array of capsule_item
* @error: location in which to store an error string on failure * specifying which symbols to export, terminated by a
* #capsule_item whose @name is %NULL
* @error: (out) (transfer full) (optional): location in which to store
* an error message on failure, or %NULL to ignore.
* Free with free().
* *
* Returns: 0 on success, non-zero on failure. * Returns: 0 on success, non-zero on failure.
* *
...@@ -104,9 +108,12 @@ int capsule_relocate (const char *target, ...@@ -104,9 +108,12 @@ int capsule_relocate (const char *target,
* @namespace: Address of an #Lmid_t value (usually %LM_ID_NEWLM) * @namespace: Address of an #Lmid_t value (usually %LM_ID_NEWLM)
* @wrappers: Array of #capsule_item used to replace symbols in the namespace * @wrappers: Array of #capsule_item used to replace symbols in the namespace
* @debug: Internal debug flags. Pass 0 here. * @debug: Internal debug flags. Pass 0 here.
* @exclude: an array of char *, each specfying a DSO not to load * @exclude: (array zero-terminated=1): an array of char *, each
* @errcode: location in which to store the error code on failure * specifying a DSO not to load, terminated by a %NULL entry
* @error: location in which to store an error message on failure * @errcode: (out): location in which to store the error code (errno) on failure
* @error: (out) (transfer full) (optional): location in which to store
* an error message on failure, or %NULL to ignore.
* Free with free().
* *
* Returns: A (void *) DSO handle, as per dlopen(3), or %NULL on error * Returns: A (void *) DSO handle, as per dlopen(3), or %NULL on error
* *
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment