Add a whole bunch of documentation

This commit is contained in:
Matt Williams
2012-10-27 18:52:50 +01:00
parent 313f7a11ec
commit 856cdca604
8 changed files with 73 additions and 13 deletions

View File

@ -50,7 +50,7 @@ namespace PolyVox
}
////////////////////////////////////////////////////////////////////////////////
/// The border value is returned whenever an atempt is made to read a voxel which
/// The border value is returned whenever an attempt is made to read a voxel which
/// is outside the extents of the volume.
/// \return The value used for voxels outside of the volume
////////////////////////////////////////////////////////////////////////////////
@ -230,7 +230,9 @@ namespace PolyVox
}
////////////////////////////////////////////////////////////////////////////////
/// Note: This function needs reviewing for accuracy...
/// \todo This function needs reviewing for accuracy...
///
/// \return The number of bytes used
////////////////////////////////////////////////////////////////////////////////
template <typename VoxelType>
uint32_t SimpleVolume<VoxelType>::calculateSizeInBytes(void)