From eef0bebacfaa5b19583bb67976bb1d5906c54b32 Mon Sep 17 00:00:00 2001 From: David Williams Date: Sun, 3 Jan 2016 22:31:24 +0000 Subject: [PATCH] Various documentation enhancements. --- include/PolyVox/BaseVolume.h | 2 +- include/PolyVox/DefaultIsQuadNeeded.h | 9 +++++++++ include/PolyVox/DefaultMarchingCubesController.h | 2 +- include/PolyVox/Density.h | 4 +++- include/PolyVox/Exceptions.h | 2 +- 5 files changed, 15 insertions(+), 4 deletions(-) diff --git a/include/PolyVox/BaseVolume.h b/include/PolyVox/BaseVolume.h index a640ddc6..5a423893 100644 --- a/include/PolyVox/BaseVolume.h +++ b/include/PolyVox/BaseVolume.h @@ -35,7 +35,7 @@ namespace PolyVox /// The BaseVolume class provides common functionality and an interface for other volume classes to implement. /// You should not try to create an instance of this class directly. Instead you should use RawVolume or PagedVolume. //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// - /// More details to come... + /// \sa RawVolume, PagedVolume //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// template class BaseVolume diff --git a/include/PolyVox/DefaultIsQuadNeeded.h b/include/PolyVox/DefaultIsQuadNeeded.h index f0fff005..d8b3dd3b 100644 --- a/include/PolyVox/DefaultIsQuadNeeded.h +++ b/include/PolyVox/DefaultIsQuadNeeded.h @@ -31,6 +31,15 @@ namespace PolyVox { + /// Default implementation of a function object for deciding when + /// the cubic surface extractor should insert a face between two voxels. + /// + /// The criteria used here are that the voxel in front of the potential + /// quad should have a value of zero (which would typically indicate empty + /// space) while the voxel behind the potential quad would have a value + /// geater than zero (typically indicating it is solid). Note that for + /// different behaviour users can create their own implementation and pass + /// it to extractCubicMesh(). template class DefaultIsQuadNeeded { diff --git a/include/PolyVox/DefaultMarchingCubesController.h b/include/PolyVox/DefaultMarchingCubesController.h index f9cf92a1..463f301f 100644 --- a/include/PolyVox/DefaultMarchingCubesController.h +++ b/include/PolyVox/DefaultMarchingCubesController.h @@ -56,7 +56,7 @@ namespace PolyVox * will pass through the density value specified by the threshold, and so you should make sure that the threshold value you choose is between * the minimum and maximum values found in your volume data. By default it is in the middle of the representable range of the underlying type. * - * \sa MarchingCubesSurfaceExtractor + * \sa extractMarchingCubesMesh * */ template diff --git a/include/PolyVox/Density.h b/include/PolyVox/Density.h index 05324575..c2a7d7bf 100644 --- a/include/PolyVox/Density.h +++ b/include/PolyVox/Density.h @@ -38,7 +38,9 @@ namespace PolyVox { /// This class represents a voxel storing only a density. //////////////////////////////////////////////////////////////////////////////// - /// Detailed description... + /// Note that this should probably just be considered an example of how to define + /// a voxel type for the Marching Cubes algorithm. Advanced users are likely to + /// define custom voxel types and possibly custom controllers. //////////////////////////////////////////////////////////////////////////////// template class Density diff --git a/include/PolyVox/Exceptions.h b/include/PolyVox/Exceptions.h index dcadc10f..31b1e5b4 100644 --- a/include/PolyVox/Exceptions.h +++ b/include/PolyVox/Exceptions.h @@ -28,7 +28,7 @@ #include // For base exception classes. #include // Exception constuctors take strings. -// These exceptions form part of the public API because lcient code may need to catch them. +// These exceptions form part of the public API because client code may need to catch them. // Note that our utility macros such as 'POLYVOX_THROW_IF' do not form part of the public API // as they are only for our own internal use. namespace PolyVox