Add basic description for all classes

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

diff --git a/source/geometry/circle.h b/source/geometry/circle.h
index ebc1c41b2501347852c94653f83c666dd5711772..3a2cfc286dc82049117ab324dddd2fe52f5097e7 100644 (file)
--- a/source/geometry/circle.h
+++ b/source/geometry/circle.h
@@ -6,6 +6,11 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+The two-dimensional special case of a HyperSphere.  This class exists for
+convenience only and does not provide any extra functionality over the base
+class.
+*/
 template<typename T>
 class Circle: public HyperSphere<T, 2>
 {