From 74a7bf449343f1d33b9d1bcf8cd59f5b0dfaf09d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Odin=20Omdal=20H=C3=B8rthe?= <odin.horthe@gmail.com>
Date: Sat, 20 Oct 2007 17:27:27 +0200
Subject: [PATCH] Made a @file-skeleton for doxygen for the files in src/lib/

---
 src/lib/condition.c  | 3 +++
 src/lib/condition.h  | 4 ++++
 src/lib/error.c      | 5 +++++
 src/lib/error.h      | 2 +-
 src/lib/framerate.c  | 5 +++++
 src/lib/framerate.h  | 5 +++++
 src/lib/locking.h    | 4 ++++
 src/lib/mutex.c      | 5 +++++
 src/lib/mutex.h      | 5 +++++
 src/lib/plugin.c     | 5 +++++
 src/lib/plugin.h     | 5 +++++
 src/lib/references.h | 5 +++++
 src/lib/rwlock.c     | 4 ++++
 src/lib/rwlock.h     | 4 ++++
 src/lib/time.h       | 1 +
 15 files changed, 61 insertions(+), 1 deletion(-)

diff --git a/src/lib/condition.c b/src/lib/condition.c
index 795cd121e..dfc79c7c5 100644
--- a/src/lib/condition.c
+++ b/src/lib/condition.c
@@ -21,6 +21,9 @@
 
 #include "lib/condition.h"
 
+/**
+ * @file Condition variables
+ */
 
 /**
  * Initialize a condition variable
diff --git a/src/lib/condition.h b/src/lib/condition.h
index 67e8175e7..7925fd993 100644
--- a/src/lib/condition.h
+++ b/src/lib/condition.h
@@ -24,6 +24,10 @@
 
 #include "lib/locking.h"
 
+/**
+ * @file Condition variables, header
+ */
+
 
 /**
  * Condition variables.
diff --git a/src/lib/error.c b/src/lib/error.c
index 910db3984..49756c614 100644
--- a/src/lib/error.c
+++ b/src/lib/error.c
@@ -23,6 +23,11 @@
 
 #include "lib/error.h"
 
+/**
+ * @file C Error handling in Cinelerra.
+ */
+
+
 /*
   predefined errors
 */
diff --git a/src/lib/error.h b/src/lib/error.h
index 21d9dcb73..2b5051652 100644
--- a/src/lib/error.h
+++ b/src/lib/error.h
@@ -31,7 +31,7 @@ extern "C" {
 #include <stdlib.h>
 
 /**
- * C Error handling in Cinelerra.
+ * @file C Error handling in Cinelerra, header.
  */
 
 
diff --git a/src/lib/framerate.c b/src/lib/framerate.c
index 138a338a3..b70121a37 100644
--- a/src/lib/framerate.c
+++ b/src/lib/framerate.c
@@ -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");
diff --git a/src/lib/framerate.h b/src/lib/framerate.h
index 2df5971fb..1e862ed0d 100644
--- a/src/lib/framerate.h
+++ b/src/lib/framerate.h
@@ -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
diff --git a/src/lib/locking.h b/src/lib/locking.h
index fce854b0d..6e53fee97 100644
--- a/src/lib/locking.h
+++ b/src/lib/locking.h
@@ -28,6 +28,10 @@
 
 #include "lib/error.h"
 
+/**
+ * @file Shared declarations for all locking primitives.
+ */
+
 /**
  * used to store the current lock state.
  *
diff --git a/src/lib/mutex.c b/src/lib/mutex.c
index 0c38f95ce..1425fdd02 100644
--- a/src/lib/mutex.c
+++ b/src/lib/mutex.c
@@ -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
diff --git a/src/lib/mutex.h b/src/lib/mutex.h
index 32a116f01..a359d9b75 100644
--- a/src/lib/mutex.h
+++ b/src/lib/mutex.h
@@ -24,6 +24,11 @@
 
 #include "lib/locking.h"
 
+/**
+ * @file Mutual exclusion locking, header.
+ */
+
+
 /**
  * Mutex.
  *
diff --git a/src/lib/plugin.c b/src/lib/plugin.c
index 062e266b5..f71eab529 100644
--- a/src/lib/plugin.c
+++ b/src/lib/plugin.c
@@ -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"
 
diff --git a/src/lib/plugin.h b/src/lib/plugin.h
index a710c8285..a31e69199 100644
--- a/src/lib/plugin.h
+++ b/src/lib/plugin.h
@@ -32,6 +32,11 @@ extern "C" {
 
 #include "error.h"
 
+/**
+ * @file Plugin loader, header.
+ */
+
+
 NOBUG_DECLARE_FLAG (cinelerra_plugin);
 
 /* tool macros*/
diff --git a/src/lib/references.h b/src/lib/references.h
index dd5988ec7..5f5543787 100644
--- a/src/lib/references.h
+++ b/src/lib/references.h
@@ -24,6 +24,11 @@
 
 #include <nobug.h>
 
+/**
+ * @file Strong and Weak references, header.
+ */
+
+
 typedef struct cinelerra_reference_struct cinelerra_reference;
 typedef cinelerra_reference* CinelerraReference;
 
diff --git a/src/lib/rwlock.c b/src/lib/rwlock.c
index d59b8c2d2..a2de75be8 100644
--- a/src/lib/rwlock.c
+++ b/src/lib/rwlock.c
@@ -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
diff --git a/src/lib/rwlock.h b/src/lib/rwlock.h
index c7cc7ed16..21ad1e054 100644
--- a/src/lib/rwlock.h
+++ b/src/lib/rwlock.h
@@ -34,6 +34,10 @@
 CINELERRA_ERROR_DECLARE(RWLOCK_AGAIN);
 CINELERRA_ERROR_DECLARE(RWLOCK_DEADLOCK);
 
+/**
+ * @file Read/write locks, header.
+ */
+
 
 /**
  * RWLock.
diff --git a/src/lib/time.h b/src/lib/time.h
index a2dea483b..34c0035e4 100644
--- a/src/lib/time.h
+++ b/src/lib/time.h
@@ -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