Add Doxyfile, change docs

This commit is contained in:
Nils O. Selåsdal
2012-11-01 18:58:53 +01:00
parent cef7e3b057
commit 9aa6edf902
7 changed files with 1849 additions and 63 deletions
+4 -4
View File
@@ -30,13 +30,13 @@ typedef struct SAlloc SAlloc;
* for another 1000 struct Foo's.. All these memory pieces are released
* when the uc_free_salloc() is called.
*
* @chunksz Size of each piece of memory block allocated.
* @param chunksz Size of each piece of memory block allocated.
* @return A new handle for a SAlloc, or NULL.
*/
SAlloc *uc_new_salloc(size_t chunksz);
/** Allocate memory from a SAlloc.
* @sz size of the memory. This must be <= the chunksz the SAlloc was
* @param sz size of the memory. This must be <= the chunksz the SAlloc was
* created with.
* @return The new memory, or NULL if sz > chunksz or an underlying
* malloc call fails.
@@ -49,7 +49,7 @@ void * uc_s_allocz(SAlloc *p,size_t sz);
/** Free the SAlloc and all memory associated with this SAlloc.
* The SAlloc is not usable any more after this call.
*
* @p The SAlloc to free.
* @param p The SAlloc to free.
*/
void uc_free_salloc(SAlloc *p);
@@ -58,7 +58,7 @@ void uc_free_salloc(SAlloc *p);
* The actual memory previously allocated from this SAlloc is cached,
* and will be reused by subsequent uc_s_alloc calls.
*
* @p The SAlloc to reset.
* @param p The SAlloc to reset.
*/
void uc_reset_salloc(SAlloc *p);