Doxygen config update
* set EXPORT_ALL=NO to leave out undcoumented entities. * Fix a lot @file directives
This commit is contained in:
parent
4ed2fe9e7c
commit
00b9dff106
22 changed files with 45 additions and 22 deletions
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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'.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,8 @@
|
|||
#include "lib/condition.h"
|
||||
|
||||
/**
|
||||
* @file Condition variables
|
||||
* @file
|
||||
* Condition variables
|
||||
*/
|
||||
|
||||
LUMIERA_ERROR_DEFINE (CONDITION_DESTROY, "condition destroy failed");
|
||||
|
|
|
|||
|
|
@ -25,7 +25,8 @@
|
|||
#include "lib/locking.h"
|
||||
|
||||
/**
|
||||
* @file Condition variables, header
|
||||
* @file
|
||||
* Condition variables, header
|
||||
*/
|
||||
|
||||
LUMIERA_ERROR_DECLARE (CONDITION_DESTROY);
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,8 @@
|
|||
#include "lib/error.h"
|
||||
|
||||
/**
|
||||
* @file C Error handling in Lumiera.
|
||||
* @file
|
||||
* C Error handling in Lumiera.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,8 @@ extern "C" {
|
|||
#include <stdlib.h>
|
||||
|
||||
/**
|
||||
* @file C Error handling in Lumiera, header.
|
||||
* @file
|
||||
* C Error handling in Lumiera, header.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,8 @@
|
|||
#include "lib/mutex.h"
|
||||
|
||||
/**
|
||||
* @file Mutual exclusion locking.
|
||||
* @file
|
||||
* Mutual exclusion locking.
|
||||
*/
|
||||
|
||||
LUMIERA_ERROR_DEFINE (MUTEX_LOCK, "Mutex locking failed");
|
||||
|
|
|
|||
|
|
@ -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__##_); \
|
||||
|
|
|
|||
|
|
@ -31,7 +31,8 @@
|
|||
#include "safeclib.h"
|
||||
|
||||
/**
|
||||
* @file Plugin loader.
|
||||
* @file
|
||||
* Plugin loader.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,8 @@ extern "C" {
|
|||
#include "error.h"
|
||||
|
||||
/**
|
||||
* @file Plugin loader, header.
|
||||
* @file
|
||||
* Plugin loader, header.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*
|
||||
|
|
|
|||
|
|
@ -25,7 +25,8 @@
|
|||
#include <nobug.h>
|
||||
|
||||
/**
|
||||
* @file Strong and Weak references, header.
|
||||
* @file
|
||||
* Strong and Weak references, header.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,8 @@ LUMIERA_ERROR_DEFINE(RWLOCK_RLOCK, "rlock");
|
|||
LUMIERA_ERROR_DEFINE(RWLOCK_WLOCK, "wlock");
|
||||
|
||||
/**
|
||||
* @file Read/write locks.
|
||||
* @file
|
||||
* Read/write locks.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,8 @@ LUMIERA_ERROR_DECLARE(RWLOCK_RLOCK);
|
|||
LUMIERA_ERROR_DECLARE(RWLOCK_WLOCK);
|
||||
|
||||
/**
|
||||
* @file Read/write locks, header.
|
||||
* @file
|
||||
* Read/write locks, header.
|
||||
*/
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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!");
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue