benn/lumiera_documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated function docs to use the actual variables and cut textwidth at 105

Browse source
This commit is contained in:
Odin Omdal Hørthe 2007-10-20 17:50:42 +02:00
parent 8afd4e1b8d
commit 9952aa33a4
2 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/lib/error.c
View file

@ -47,8 +47,9 @@ cinelerra_error_tls_init (void)
/**
* Set error state for the current thread.
* If the error state of the current thread was cleared, then set it, else preserve the old state.
* @param err name of the error with 'CINELERRA_ERROR_' prefix (example: CINELERRA_ERROR_NO_MEMORY)
* @return old state, that is NULL for success, when the state was cleared and a pointer to a pending error when the error state was already set
* @param nerr name of the error with 'CINELERRA_ERROR_' prefix (example: CINELERRA_ERROR_NO_MEMORY)
* @return old state, that is NULL for success, when the state was cleared and a pointer to a pending
* error when the error state was already set
*/
const char*
cinelerra_error_set (const char * nerr)
@ -65,7 +66,8 @@ cinelerra_error_set (const char * nerr)
/**
* Get and clear current error state.
* This function clears the error state, if it needs to be reused, one has to store it in a temporary variable.
* This function clears the error state, if it needs to be reused, one has to store it in a temporary
* variable.
* @return pointer to any pending error of this thread, NULL if no error is pending
*/
const char*

21
src/lib/plugin.c
View file

@ -98,7 +98,10 @@ void* cinelerra_plugin_registry = NULL;
/* plugin operations are protected by one big mutex */
pthread_mutex_t cinelerra_plugin_mutex = PTHREAD_MUTEX_INITIALIZER;
/* the compare function for the registry tree */
/**
* the compare function for the registry tree.
* Compares the names of two struct cinelerra_plugin.
* @return 0 if a and b are equal, just like strcmp. */
static int
cinelerra_plugin_name_cmp (const void* a, const void* b)
{
@ -169,12 +172,14 @@ cinelerra_plugin_lookup (struct cinelerra_plugin* self, const char* path)
/**
* Make an interface available.
* To use an interface provided by a plugin it must be opened first. It is allowed to open an interface more than once.
* Each open must be paired with a close.
* @param plugin name of the plugin to use.
* @param name name of the interface to open.
* @param min_revision the size of the interface structure is used as measure of a minimal required revision (new functions are appended at the end)
* @return handle to the interface or NULL in case of a error. The application shall cast this handle to the actual interface type.
* To use an interface provided by a plugin it must be opened first. It is allowed to open an interface
* more than once. Each open must be paired with a close.
* @param name name of the plugin to use.
* @param interface name of the interface to open.
* @param min_revision the size of the interface structure is used as measure of a minimal required
* revision (new functions are appended at the end)
* @return handle to the interface or NULL in case of a error. The application shall cast this handle to
* the actual interface type.
*/
struct cinelerra_interface*
cinelerra_interface_open (const char* name, const char* interface, size_t min_revision)
@ -307,7 +312,7 @@ cinelerra_interface_open (const char* name, const char* interface, size_t min_re
/**
* Close an interface. Does not free associated resources
* Calling this function with self==NULL is legal. Every interface handle must be closed only once.
* @param self interface to be closed
* @param ptr interface to be closed
*/
void
cinelerra_interface_close (void* ptr)