diff --git a/lladd/io/handle.h b/lladd/io/handle.h index d04123e..112bb8b 100644 --- a/lladd/io/handle.h +++ b/lladd/io/handle.h @@ -7,6 +7,9 @@ #define stasis_handle(x) stasis_handle_##x /** + + @file + Error handling: read, write, append, open, release_read_buffer and diff --git a/lladd/io/rangeTracker.h b/lladd/io/rangeTracker.h index f423a57..794fd6c 100644 --- a/lladd/io/rangeTracker.h +++ b/lladd/io/rangeTracker.h @@ -1,3 +1,5 @@ + +/** @file */ typedef struct range { long start; long stop; @@ -46,4 +48,3 @@ static inline long rangeTrackerRoundDown(long x, long quant) { static inline long rangeTrackerRoundUp(long x, long quant) { return (((x-1) / quant) + 1) * quant; } - diff --git a/src/lladd/fifo.c b/src/lladd/fifo.c index 4d9021c..3ab5cc3 100644 --- a/src/lladd/fifo.c +++ b/src/lladd/fifo.c @@ -25,7 +25,7 @@ void lladdFifoPool_markDirty(int xid, lladdFifoPool_t * pool, lladdFifo_t * fifo /** Create a new pool of ringBuffer based fifos - @param consumerCount the number of consumers in the pool. + consumerCount is the number of consumers in the pool. @todo this function should be generalized to other consumer implementations. */ lladdFifoPool_t * lladdFifoPool_ringBufferInit (int consumerCount, int bufferSize, diff --git a/src/lladd/io.c b/src/lladd/io.c index 7781b4f..9e40278 100644 --- a/src/lladd/io.c +++ b/src/lladd/io.c @@ -1,6 +1,11 @@ #include #include "io.h" #include +/** @file + + This file contains old-ish utility methods that wrap fseek, read, etc... + +*/ long myFseek(FILE * f, long offset, int whence) { long ret; flockfile(f); diff --git a/src/lladd/io/debug.c b/src/lladd/io/debug.c index a002686..06c6daf 100644 --- a/src/lladd/io/debug.c +++ b/src/lladd/io/debug.c @@ -2,6 +2,13 @@ #include #include +/** @file + + This implements a io handle that wraps another handle, logging each + call (and its result) to stdout. + +*/ + typedef struct debug_impl { stasis_handle_t * h; } debug_impl; diff --git a/src/lladd/io/file.c b/src/lladd/io/file.c index dd73b62..5377c98 100644 --- a/src/lladd/io/file.c +++ b/src/lladd/io/file.c @@ -13,6 +13,7 @@ #include #include +/** @file */ typedef struct file_impl { pthread_mutex_t mut; diff --git a/src/lladd/io/memory.c b/src/lladd/io/memory.c index 6e4bc6f..e88ca32 100644 --- a/src/lladd/io/memory.c +++ b/src/lladd/io/memory.c @@ -3,7 +3,7 @@ #include #include #include - +/** @file */ typedef struct mem_impl { pthread_mutex_t mut; diff --git a/src/lladd/io/non_blocking.c b/src/lladd/io/non_blocking.c index 42f89d8..1169d24 100644 --- a/src/lladd/io/non_blocking.c +++ b/src/lladd/io/non_blocking.c @@ -6,7 +6,9 @@ #include #include #include -/* +/** + + @file Design: diff --git a/src/lladd/page/header.c b/src/lladd/page/header.c index f8d588d..30b322b 100644 --- a/src/lladd/page/header.c +++ b/src/lladd/page/header.c @@ -32,7 +32,7 @@ void freePage(Page * freepage, long freepage_id, Page * headerpage) { } /** - @param freepage Must be the head of the freepage list (right now, + freepage Must be the head of the freepage list (right now, the free list is essentially treated like a stack. */ void unfreePage(Page * freepage, Page * headerpage) {