aboutsummaryrefslogtreecommitdiffstats
path: root/src/alloc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-15 22:28:02 +0000
committerlloyd <[email protected]>2010-06-15 22:28:02 +0000
commit7dbef9e3e2efd2354bb4ca97fca0d720a8957db4 (patch)
treee6d563d6658a93ba5caffcf8975a065d98ca6c38 /src/alloc
parent416695f7363c4e93eaeaea23427a1fed3ad73cab (diff)
More Doxygen fixes
Diffstat (limited to 'src/alloc')
-rw-r--r--src/alloc/alloc_mmap/mmap_mem.h7
-rw-r--r--src/alloc/allocate.h2
-rw-r--r--src/alloc/mem_pool/mem_pool.h2
-rw-r--r--src/alloc/system_alloc/defalloc.h8
4 files changed, 11 insertions, 8 deletions
diff --git a/src/alloc/alloc_mmap/mmap_mem.h b/src/alloc/alloc_mmap/mmap_mem.h
index da3dda31d..be1d06cff 100644
--- a/src/alloc/alloc_mmap/mmap_mem.h
+++ b/src/alloc/alloc_mmap/mmap_mem.h
@@ -12,8 +12,11 @@
namespace Botan {
-/*
-* Memory Mapping Allocator
+/**
+* Allocator that uses memory maps backed by disk. We zeroize the map
+* upon deallocation. If swap occurs, the VM will swap to the shared
+* file backing rather than to a swap device, which means we know where
+* it is and can zap it later.
*/
class MemoryMapping_Allocator : public Pooling_Allocator
{
diff --git a/src/alloc/allocate.h b/src/alloc/allocate.h
index 180f2c021..819e2542c 100644
--- a/src/alloc/allocate.h
+++ b/src/alloc/allocate.h
@@ -13,7 +13,7 @@
namespace Botan {
-/*
+/**
* Allocator Interface
*/
class BOTAN_DLL Allocator
diff --git a/src/alloc/mem_pool/mem_pool.h b/src/alloc/mem_pool/mem_pool.h
index 9735a547d..69555544e 100644
--- a/src/alloc/mem_pool/mem_pool.h
+++ b/src/alloc/mem_pool/mem_pool.h
@@ -16,7 +16,7 @@
namespace Botan {
-/*
+/**
* Pooling Allocator
*/
class Pooling_Allocator : public Allocator
diff --git a/src/alloc/system_alloc/defalloc.h b/src/alloc/system_alloc/defalloc.h
index 0c8804223..27ee3cd8f 100644
--- a/src/alloc/system_alloc/defalloc.h
+++ b/src/alloc/system_alloc/defalloc.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Malloc Allocator
+/**
+* Allocator using malloc
*/
class Malloc_Allocator : public Allocator
{
@@ -24,8 +24,8 @@ class Malloc_Allocator : public Allocator
std::string type() const { return "malloc"; }
};
-/*
-* Locking Allocator
+/**
+* Allocator using malloc plus locking
*/
class Locking_Allocator : public Pooling_Allocator
{