Add basic description for all classes

[libs/math.git] / source / geometry / shape.h

diff --git a/source/geometry/shape.h b/source/geometry/shape.h
index 1f8176418a4e9a948b460701e6e682d56ae31771..3f52613bef98d9df47e3c935fd4ddca213e98b82 100644 (file)
--- a/source/geometry/shape.h
+++ b/source/geometry/shape.h
@@ -16,6 +16,11 @@ class Ray;
 template<typename T, unsigned D>
 class SurfacePoint;
 
+/**
+Base class and interface for geometric shapes.  Shapes may be bounded or
+unbounded.  They are always considered to be solid, i.e. have a distinct inside
+and an outside.
+*/
 template<typename T, unsigned D>
 class Shape
 {