Add basic description for all classes

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

diff --git a/source/geometry/hypersphere.h b/source/geometry/hypersphere.h
index f95ebe4182094667533e2cec0914210cb7b79337..ed2b49ff161141e4364a5bd81773ed0c9cc16632 100644 (file)
--- a/source/geometry/hypersphere.h
+++ b/source/geometry/hypersphere.h
@@ -10,6 +10,10 @@
 namespace Msp {
 namespace Geometry {
 
+/**
+A shape consisting of the points within a specific distance from the origin.
+Two- and three-dimensional cases are Circle and Sphere, respectively.
+*/
 template<typename T, unsigned D>
 class HyperSphere: public Shape<T, D>
 {