From 00b9dff106d018c03a704e3b5db1e92467c25f3b Mon Sep 17 00:00:00 2001
From: Christian Thaeter <ct@pipapo.org>
Date: Thu, 10 Apr 2008 02:40:34 +0200
Subject: [PATCH] Doxygen config update

* set EXPORT_ALL=NO to leave out undcoumented entities.
* Fix a lot @file directives
---
 src/backend/file.h            | 3 ++-
 src/backend/filedescriptor.h  | 4 +++-
 src/backend/filehandle.h      | 3 ++-
 src/backend/filehandlecache.h | 3 ++-
 src/lib/condition.c           | 3 ++-
 src/lib/condition.h           | 3 ++-
 src/lib/cuckoo.h              | 3 ++-
 src/lib/error.c               | 3 ++-
 src/lib/error.h               | 3 ++-
 src/lib/llist.h               | 3 ++-
 src/lib/locking.h             | 3 ++-
 src/lib/mrucache.h            | 3 ++-
 src/lib/mutex.c               | 3 ++-
 src/lib/mutex.h               | 3 ++-
 src/lib/plugin.c              | 3 ++-
 src/lib/plugin.h              | 3 ++-
 src/lib/references.c          | 3 ++-
 src/lib/references.h          | 3 ++-
 src/lib/rwlock.c              | 3 ++-
 src/lib/rwlock.h              | 3 ++-
 src/lib/safeclib.c            | 3 ++-
 src/lib/safeclib.h            | 3 ++-
 22 files changed, 45 insertions(+), 22 deletions(-)

diff --git a/src/backend/file.h b/src/backend/file.h
index 9e774b94d..175b93e9d 100644
--- a/src/backend/file.h
+++ b/src/backend/file.h
@@ -30,7 +30,8 @@
 NOBUG_DECLARE_FLAG (file);
 
 /**
- * @file File management
+ * @file
+ * File management
  * Handling Files is splitted into different classes:
  * 1. The 'lumiera_file' class which acts as interface to the outside for managing files.
  *    'lumiera_file' is addressed by the name of the file. Since files can have more than one name (hardlinks)
diff --git a/src/backend/filedescriptor.h b/src/backend/filedescriptor.h
index 8ae19a04d..4789f9ce2 100644
--- a/src/backend/filedescriptor.h
+++ b/src/backend/filedescriptor.h
@@ -37,8 +37,10 @@ typedef lumiera_filedescriptor* LumieraFiledescriptor;
 #include "backend/file.h"
 
 /**
- * @file Filedescriptors
+ * @file
+ * Filedescriptors.
  * Filedescriptors are the underlying working horse in accessing files.
+ * All information associated with managing a file is kept here.
  */
 
 
diff --git a/src/backend/filehandle.h b/src/backend/filehandle.h
index 47fd0f3a7..e1b02b2e4 100644
--- a/src/backend/filehandle.h
+++ b/src/backend/filehandle.h
@@ -30,7 +30,8 @@ typedef lumiera_filehandle* LumieraFilehandle;
 #include "backend/filedescriptor.h"
 
 /**
- * @file Filehandles
+ * @file
+ * Filehandles.
  * Filehandles manage the underlying POSIX filehandle for a filedescriptor.
  * Since we want to support handling of more files than POSIX filehandles are available on a common system
  * the filehandles are opened, cached and closed on demand, see 'filehandlecache'.
diff --git a/src/backend/filehandlecache.h b/src/backend/filehandlecache.h
index fd6ddfd13..25964f986 100644
--- a/src/backend/filehandlecache.h
+++ b/src/backend/filehandlecache.h
@@ -31,7 +31,8 @@ typedef lumiera_filehandlecache* LumieraFilehandlecache;
 #include "backend/filehandle.h"
 
 /**
- * @file Filehandle management and caching
+ * @file
+ * Filehandle management and caching
  * The number of filehandles a program can held open is usually limited, since we want to support
  * using a less limited number of files and closing/opening for each operation is expensive, we
  * provide a cache to keep the most frequent used files open and gracefully close/recycle unused filehandles.
diff --git a/src/lib/condition.c b/src/lib/condition.c
index 1bfa2ef96..60e8b6f10 100644
--- a/src/lib/condition.c
+++ b/src/lib/condition.c
@@ -22,7 +22,8 @@
 #include "lib/condition.h"
 
 /**
- * @file Condition variables
+ * @file
+ * Condition variables
  */
 
 LUMIERA_ERROR_DEFINE (CONDITION_DESTROY, "condition destroy failed");
diff --git a/src/lib/condition.h b/src/lib/condition.h
index ffc00523c..dd92f326b 100644
--- a/src/lib/condition.h
+++ b/src/lib/condition.h
@@ -25,7 +25,8 @@
 #include "lib/locking.h"
 
 /**
- * @file Condition variables, header
+ * @file
+ * Condition variables, header
  */
 
 LUMIERA_ERROR_DECLARE (CONDITION_DESTROY);
diff --git a/src/lib/cuckoo.h b/src/lib/cuckoo.h
index 63b6d260d..323b5cc75 100644
--- a/src/lib/cuckoo.h
+++ b/src/lib/cuckoo.h
@@ -22,7 +22,8 @@
 #define CUCKOO_H
 
 /**
- * @file Cuckoo hashing
+ * @file
+ * Cuckoo hashing
  * This hashing gives guaranteed O(1) lookup complexity and amortized O(1) insert and remove complexity.
  * Hash tables by default grow and shrink automatically. It is posible to preallocate entries and turn
  * automatic shrinking off taking out the memory management factors for insert and remove operations.
diff --git a/src/lib/error.c b/src/lib/error.c
index 81e24bad8..b2bc390b6 100644
--- a/src/lib/error.c
+++ b/src/lib/error.c
@@ -24,7 +24,8 @@
 #include "lib/error.h"
 
 /**
- * @file C Error handling in Lumiera.
+ * @file
+ * C Error handling in Lumiera.
  */
 
 
diff --git a/src/lib/error.h b/src/lib/error.h
index e71c0cdfa..1eeb42dda 100644
--- a/src/lib/error.h
+++ b/src/lib/error.h
@@ -31,7 +31,8 @@ extern "C" {
 #include <stdlib.h>
 
 /**
- * @file C Error handling in Lumiera, header.
+ * @file
+ * C Error handling in Lumiera, header.
  */
 
 
diff --git a/src/lib/llist.h b/src/lib/llist.h
index efb3f5202..128a3e826 100644
--- a/src/lib/llist.h
+++ b/src/lib/llist.h
@@ -27,7 +27,8 @@
 #include <stddef.h>
 
 /**
- * @file Intrusive cyclic double linked list
+ * @file
+ * Intrusive cyclic double linked list
  * There is only one node type which contains a forward and a backward pointer. In a empty initialized node,
  * this pointers point to the node itself. Note that these pointers can never ever become NULL.
  * This lists are used by using one node as 'root' node where its both pointers are the head/tail pointer to the actual list.
diff --git a/src/lib/locking.h b/src/lib/locking.h
index f62dd6c29..3c4d497d8 100644
--- a/src/lib/locking.h
+++ b/src/lib/locking.h
@@ -34,7 +34,8 @@ LUMIERA_ERROR_DECLARE (MUTEX_UNLOCK);
 LUMIERA_ERROR_DECLARE (MUTEX_DESTROY);
 
 /**
- * @file Shared declarations for all locking primitives.
+ * @file
+ * Shared declarations for all locking primitives.
  */
 
 /**
diff --git a/src/lib/mrucache.h b/src/lib/mrucache.h
index c81bd7599..08654754f 100644
--- a/src/lib/mrucache.h
+++ b/src/lib/mrucache.h
@@ -27,7 +27,8 @@
 #include <nobug.h>
 
 /**
- * @file Most recent used cache
+ * @file
+ * Most recent used cache
  * Elements (addressed by a LList node) are either checked in the cache and thereby subject of aging
  * or checked out under control of the user. Most operations require that the chache is locked. This locking
  * must be done from elsewhere.
diff --git a/src/lib/mutex.c b/src/lib/mutex.c
index 009502e5a..b7c5f1844 100644
--- a/src/lib/mutex.c
+++ b/src/lib/mutex.c
@@ -22,7 +22,8 @@
 #include "lib/mutex.h"
 
 /**
- * @file Mutual exclusion locking.
+ * @file
+ * Mutual exclusion locking.
  */
 
 LUMIERA_ERROR_DEFINE (MUTEX_LOCK, "Mutex locking failed");
diff --git a/src/lib/mutex.h b/src/lib/mutex.h
index ca48ea592..f19058e7a 100644
--- a/src/lib/mutex.h
+++ b/src/lib/mutex.h
@@ -25,7 +25,8 @@
 #include "lib/locking.h"
 
 /**
- * @file Mutual exclusion locking, header.
+ * @file
+ * Mutual exclusion locking, header.
  */
 #define LUMIERA_MUTEX_SECTION(flag, handle, mutex)                                      \
 RESOURCE_HANDLE (rh_##__LINE__##_);                                                     \
diff --git a/src/lib/plugin.c b/src/lib/plugin.c
index 8345d9887..1f5e8576e 100644
--- a/src/lib/plugin.c
+++ b/src/lib/plugin.c
@@ -31,7 +31,8 @@
 #include "safeclib.h"
 
 /**
- * @file Plugin loader.
+ * @file
+ * Plugin loader.
  */
 
 
diff --git a/src/lib/plugin.h b/src/lib/plugin.h
index f8916ae96..54dad6372 100644
--- a/src/lib/plugin.h
+++ b/src/lib/plugin.h
@@ -33,7 +33,8 @@ extern "C" {
 #include "error.h"
 
 /**
- * @file Plugin loader, header.
+ * @file
+ * Plugin loader, header.
  */
 
 
diff --git a/src/lib/references.c b/src/lib/references.c
index 3e9d5f260..925258377 100644
--- a/src/lib/references.c
+++ b/src/lib/references.c
@@ -22,7 +22,8 @@
 #include "lib/safeclib.h"
 
 /**
- * @file Strong and Weak references
+ * @file
+ * Strong and Weak references
  * Strong references keep some object alive while they existing
  * Weak references become invalidated when the referenced object gets destroyed
  *
diff --git a/src/lib/references.h b/src/lib/references.h
index 3e00457e7..6ad65d62f 100644
--- a/src/lib/references.h
+++ b/src/lib/references.h
@@ -25,7 +25,8 @@
 #include <nobug.h>
 
 /**
- * @file Strong and Weak references, header.
+ * @file
+ * Strong and Weak references, header.
  */
 
 
diff --git a/src/lib/rwlock.c b/src/lib/rwlock.c
index 092c7b54b..077ff9766 100644
--- a/src/lib/rwlock.c
+++ b/src/lib/rwlock.c
@@ -29,7 +29,8 @@ LUMIERA_ERROR_DEFINE(RWLOCK_RLOCK, "rlock");
 LUMIERA_ERROR_DEFINE(RWLOCK_WLOCK, "wlock");
 
 /**
- * @file Read/write locks.
+ * @file
+ * Read/write locks.
  */
 
 
diff --git a/src/lib/rwlock.h b/src/lib/rwlock.h
index 5e121fbcc..d58627dda 100644
--- a/src/lib/rwlock.h
+++ b/src/lib/rwlock.h
@@ -39,7 +39,8 @@ LUMIERA_ERROR_DECLARE(RWLOCK_RLOCK);
 LUMIERA_ERROR_DECLARE(RWLOCK_WLOCK);
 
 /**
- * @file Read/write locks, header.
+ * @file
+ * Read/write locks, header.
  */
 
 
diff --git a/src/lib/safeclib.c b/src/lib/safeclib.c
index 0e82e2dc0..f500ea71c 100644
--- a/src/lib/safeclib.c
+++ b/src/lib/safeclib.c
@@ -27,7 +27,8 @@
 #include <stdarg.h>
 
 /**
- * @file Portable and safe wrapers around some clib functions and some tools
+ * @file
+ * Portable and safe wrapers around some clib functions and some tools
  */
 
 LUMIERA_ERROR_DEFINE (NO_MEMORY, "Out of Memory!");
diff --git a/src/lib/safeclib.h b/src/lib/safeclib.h
index f486ed056..6fc532239 100644
--- a/src/lib/safeclib.h
+++ b/src/lib/safeclib.h
@@ -24,7 +24,8 @@
 #include <stdlib.h>
 
 /**
- * @file Portable and safe wrapers around some clib functions and some tools
+ * @file
+ * Portable and safe wrapers around some clib functions and some tools
  */
 LUMIERA_ERROR_DECLARE(NO_MEMORY);