more doxygen documentation, modules added

git-svn-id: svn://svn.code.sf.net/p/loki-lib/code/trunk@347 7ec92016-0320-0410-acc4-a06ded1c099a

src/SmallObj.cpp

@@ -36,6 +36,7 @@ namespace Loki
 {
 
     /** @struct Chunk
+        @ingroup SmallObjectGroupInternal
      Contains info about each allocated Chunk - which is a collection of
      contiguous blocks.  Each block is the same size, as specified by the
      FixedAllocator.  The number of blocks in a Chunk depends upon page size.
@@ -128,6 +129,7 @@ namespace Loki
     };
 
     /** @class FixedAllocator
+        @ingroup SmallObjectGroupInternal
      Offers services for allocating fixed-sized objects.  It has a container
      of "containers" of fixed-size blocks.  The outer container has all the
      Chunks.  The inner container is a Chunk which owns some blocks.
@@ -697,8 +699,8 @@ void FixedAllocator::DoDeallocate(void* p)
 }
 
 // GetOffset ------------------------------------------------------------------
+/// @ingroup SmallObjectGroupInternal
 /// Calculates index into array where a FixedAllocator of numBytes is located.
-
 inline std::size_t GetOffset( std::size_t numBytes, std::size_t alignment )
 {
     const std::size_t alignExtra = alignment-1;
@@ -706,7 +708,8 @@ inline std::size_t GetOffset( std::size_t numBytes, std::size_t alignment )
 }
 
 // DefaultAllocator -----------------------------------------------------------
-/** Calls the default allocator when SmallObjAllocator decides not to handle a
+/** @ingroup SmallObjectGroupInternal
+ Calls the default allocator when SmallObjAllocator decides not to handle a
  request.  SmallObjAllocator calls this if the number of bytes is bigger than
  the size which can be handled by any FixedAllocator.
  @param doThrow True if this function should throw an exception, or false if it
@@ -726,7 +729,8 @@ void * DefaultAllocator( std::size_t numBytes, bool doThrow )
 }
 
 // DefaultDeallocator ---------------------------------------------------------
-/** Calls default deallocator when SmallObjAllocator decides not to handle a
+/** @ingroup SmallObjectGroupInternal
+ Calls default deallocator when SmallObjAllocator decides not to handle a   
  request.  The default deallocator could be the global delete operator or the
  free function.  The free function is the preferred default deallocator since
  it matches malloc which is the preferred default allocator.  SmallObjAllocator
@@ -882,6 +886,9 @@ void SmallObjAllocator::Deallocate( void * p )
 ////////////////////////////////////////////////////////////////////////////////
 
 // $Log$
+// Revision 1.16  2005/11/02 20:01:11  syntheticpp
+// more doxygen documentation, modules added
+//
 // Revision 1.15  2005/10/26 00:50:44  rich_sposato
 // Minor changes to documentation comments.
 //