From 8929f4c1ae8ce30d39389851f6448d1a6b1b56d2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Wed, 21 Aug 2013 00:36:13 +0200
Subject: [PATCH] Shapes: documentation for adding new shapes.

It's a lot of steps to rediscover.
---
 src/Shapes/shapeImplementation.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/Shapes/shapeImplementation.h b/src/Shapes/shapeImplementation.h
index 8b2a16597..898f50bd3 100644
--- a/src/Shapes/shapeImplementation.h
+++ b/src/Shapes/shapeImplementation.h
@@ -34,6 +34,23 @@
 
 namespace Magnum { namespace Shapes { namespace Implementation {
 
+/*
+    Adding new collision type:
+
+    1.  Add the type into the 2D/3D enums below, pick new prime number and
+        preserve complexity ordering
+    2.  Update debug output operators for changed enums
+    3.  Add TypeOf struct specialization (either for both 2D/3D or for only one
+        of them)
+    4.  Add the enum value to (documentation-only) enum in Composition
+    5.  Update doc/shapes.dox with new type
+
+    Adding new collision detection implementation:
+
+    1.  Update Implementation/CollisionDispatch.cpp with newly implemented
+        2D/3D pair
+*/
+
 /* Shape type for given dimension count */
 
 template<UnsignedInt> struct ShapeDimensionTraits;