From f1c57b241fa68a59ba5401439a7ced61c2d84e0f Mon Sep 17 00:00:00 2001
From: David Allemang <allemang.d@gmail.com>
Date: Fri, 3 Jan 2020 22:36:32 -0500
Subject: [PATCH] add simple docs and use namespaced tc::solve

---
 example/bench.cpp |  2 +-
 include/groups.h  | 30 ++++++++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 1 deletion(-)

diff --git a/example/bench.cpp b/example/bench.cpp
index d2980c7..baf3733 100644
--- a/example/bench.cpp
+++ b/example/bench.cpp
@@ -18,7 +18,7 @@ int main() {
 
     for (const auto &group : groups) {
         auto s = std::clock(); // to measure CPU time
-        auto cosets = solve(group);
+        auto cosets = tc::solve(group);
         auto e = std::clock();
 
         double diff = (double) (e - s) / CLOCKS_PER_SEC;
diff --git a/include/groups.h b/include/groups.h
index 94f7392..9c7a911 100644
--- a/include/groups.h
+++ b/include/groups.h
@@ -39,24 +39,54 @@ namespace tc {
     Group schlafli(const std::vector<int> &mults);
 
     namespace group {
+        /**
+         * Simplex
+         */
         Group A(int dim);
 
+        /**
+         * Cube, Orthoplex
+         */
         Group B(int dim);
 
+        /**
+         * Demicube, Orthoplex
+         */
         Group D(int dim);
 
+        /**
+         * E groups
+         */
         Group E(int dim);
 
+        /**
+         * 24 Cell
+         */
         Group F4();
 
+        /**
+         * Hexagon
+         */
         Group G2();
 
+        /**
+         * Icosahedron
+         */
         Group H(int dim);
 
+        /**
+         * Polygonal
+         */
         Group I2(int n);
 
+        /**
+         * Toroidal. I2(n) * I2(m)
+         */
         Group T(int n, int m);
 
+        /**
+         * Toroidal. T(n, n)
+         */
         Group T(int n);
     }
 }
\ No newline at end of file