Made a @file-skeleton for doxygen for the files in src/lib/

This commit is contained in:
Odin Omdal Hørthe 2007-10-20 17:27:27 +02:00
parent d9c9b4e15e
commit 74a7bf4493
15 changed files with 61 additions and 1 deletions

View file

@ -21,6 +21,9 @@
#include "lib/condition.h"
/**
* @file Condition variables
*/
/**
* Initialize a condition variable

View file

@ -24,6 +24,10 @@
#include "lib/locking.h"
/**
* @file Condition variables, header
*/
/**
* Condition variables.

View file

@ -23,6 +23,11 @@
#include "lib/error.h"
/**
* @file C Error handling in Cinelerra.
*/
/*
predefined errors
*/

View file

@ -31,7 +31,7 @@ extern "C" {
#include <stdlib.h>
/**
* C Error handling in Cinelerra.
* @file C Error handling in Cinelerra, header.
*/

View file

@ -21,5 +21,10 @@
#include "lib/error.h"
/**
* @file Framerate calculations.
*/
CINELERRA_ERROR_DEFINE(FRAMERATE_ILLEGAL_TIME, "invalid time given");
CINELERRA_ERROR_DEFINE(FRAMERATE_ILLEGAL_FRAME, "invalid frame given");

View file

@ -27,6 +27,11 @@
#include "lib/error.h"
#include "lib/time.h"
/**
* @file Framerate calculations, header.
*/
/**
* framerates are defined as a rational number
* for example NTSC with 30000/1001fps

View file

@ -28,6 +28,10 @@
#include "lib/error.h"
/**
* @file Shared declarations for all locking primitives.
*/
/**
* used to store the current lock state.
*

View file

@ -21,6 +21,11 @@
#include "lib/mutex.h"
/**
* @file Mutual exclusion locking.
*/
/**
* Initialize a mutex variable
* @param self is a pointer to the mutex to be initialized

View file

@ -24,6 +24,11 @@
#include "lib/locking.h"
/**
* @file Mutual exclusion locking, header.
*/
/**
* Mutex.
*

View file

@ -28,6 +28,11 @@
#include "plugin.h"
/**
* @file Plugin loader.
*/
/* TODO should be set by the build system to the actual plugin path */
#define CINELERRA_PLUGIN_PATH "~/.cinelerra3/plugins:/usr/local/lib/cinelerra3/plugins:.libs"

View file

@ -32,6 +32,11 @@ extern "C" {
#include "error.h"
/**
* @file Plugin loader, header.
*/
NOBUG_DECLARE_FLAG (cinelerra_plugin);
/* tool macros*/

View file

@ -24,6 +24,11 @@
#include <nobug.h>
/**
* @file Strong and Weak references, header.
*/
typedef struct cinelerra_reference_struct cinelerra_reference;
typedef cinelerra_reference* CinelerraReference;

View file

@ -26,6 +26,10 @@
CINELERRA_ERROR_DEFINE(RWLOCK_AGAIN, "maximum number of readlocks exceed");
CINELERRA_ERROR_DEFINE(RWLOCK_DEADLOCK, "deadlock detected");
/**
* @file Read/write locks.
*/
/**
* Initialize a rwlock

View file

@ -34,6 +34,10 @@
CINELERRA_ERROR_DECLARE(RWLOCK_AGAIN);
CINELERRA_ERROR_DECLARE(RWLOCK_DEADLOCK);
/**
* @file Read/write locks, header.
*/
/**
* RWLock.

View file

@ -29,6 +29,7 @@
#include "lib/error.h"
/*
* @file Time calculations.
this time functions are small macro like wrapers, they are all inlined for performance reasons
time is passed around as pointers, this pointer must never be NULL