Skip to content
Snippets Groups Projects
Commit 761a6878 authored by Vivek Das Mohapatra's avatar Vivek Das Mohapatra
Browse files

capsule/capsule.h: Minor doc-comment style/content changes

parent a9154be5
No related branches found
No related tags found
1 merge request!311Build capsule-capture-libs from a bundled copy of libcapsule
...@@ -111,7 +111,7 @@ struct _capsule_metadata ...@@ -111,7 +111,7 @@ struct _capsule_metadata
* *
* Returns: a #capsule handle. * Returns: a #capsule handle.
* *
* Does any initialisation necessary to use libcapsule's functions. * Does any initialisation necessary to use libcapsules functions.
* *
* Initialises internal accounting structures within the capsule * Initialises internal accounting structures within the capsule
* and triggers the metadata setup if this caspsule has been * and triggers the metadata setup if this caspsule has been
...@@ -173,8 +173,8 @@ void *capsule_shim_dlopen (const capsule cap, const char *file, int flag); ...@@ -173,8 +173,8 @@ void *capsule_shim_dlopen (const capsule cap, const char *file, int flag);
* directly in its own code (libGL is an example of this). * directly in its own code (libGL is an example of this).
* *
* Since the target library may have a different symbol set than the * Since the target library may have a different symbol set than the
* one the libcapsule proxy shim was generated from we can't rely on * one the libcapsule proxy shim was generated from we cant rely on
* dlsym() finding those symbols in the shim's symbol table. * dlsym() finding those symbols in the shims symbol table.
* *
* Instead we must intercept dlsym() calls made outside the capsule * Instead we must intercept dlsym() calls made outside the capsule
* and attempt to look for the required symbol in the namespace defined * and attempt to look for the required symbol in the namespace defined
...@@ -220,10 +220,10 @@ void *capsule_external_dlopen(const char *file, int flag); ...@@ -220,10 +220,10 @@ void *capsule_external_dlopen(const char *file, int flag);
* capsule_close: * capsule_close:
* @cap: a #capsule handle as returned by capsule_init() * @cap: a #capsule handle as returned by capsule_init()
* *
* This function should be called from a capsule proxy library's destructor: * This function should be called from a capsule proxy librarys destructor:
* Its job is to clean up capsule-specific allocated memory and metadata when * Its job is to clean up capsule-specific allocated memory and metadata when
* a capsule proxy is discarded via dlclose(), and ensure that libproxy itself * a capsule proxy is discarded via dlclose(), and ensure that libproxy itself
* won't try to access any related invalidated memory afterwards. * wont try to access any related invalidated memory afterwards.
*/ */
_CAPSULE_PUBLIC _CAPSULE_PUBLIC
void capsule_close (capsule cap); void capsule_close (capsule cap);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment