From 33d17dbab86c1277a1327273fb9753b2c98b7b03 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sat, 22 Jun 2024 14:32:19 +0200
Subject: more documentation

---
 puzzle/dummy/index.dox |  9 +++++++++
 puzzle/neo/index.dox   |  6 ++++++
 puzzle/readme.md       | 17 +++++++++++------
 puzzle/vault/index.dox |  6 ++++++
 4 files changed, 32 insertions(+), 6 deletions(-)
 create mode 100644 puzzle/dummy/index.dox
 create mode 100644 puzzle/neo/index.dox
 create mode 100644 puzzle/vault/index.dox

(limited to 'puzzle')

diff --git a/puzzle/dummy/index.dox b/puzzle/dummy/index.dox
new file mode 100644
index 0000000..918bf7f
--- /dev/null
+++ b/puzzle/dummy/index.dox
@@ -0,0 +1,9 @@
+// vim:ft=doxygen
+/**
+\ingroup puz
+\defgroup puz_dummy Dummy
+\brief Demo puzzle module
+
+The dummy puzzle module consists of an empty Arduino sketch, and can be used as
+a starting point for developing new puzzle modules.
+*/
diff --git a/puzzle/neo/index.dox b/puzzle/neo/index.dox
new file mode 100644
index 0000000..14cefdc
--- /dev/null
+++ b/puzzle/neo/index.dox
@@ -0,0 +1,6 @@
+// vim:ft=doxygen
+/**
+\ingroup puz
+\defgroup puz_neo Neo
+\brief NeoTrellis puzzle module
+*/
diff --git a/puzzle/readme.md b/puzzle/readme.md
index 59c10b1..959c506 100644
--- a/puzzle/readme.md
+++ b/puzzle/readme.md
@@ -1,15 +1,20 @@
+\defgroup puz puzzle
+\brief Puzzle modules
+
 # puzzles
 
 This folder contains the source code for all puzzle modules.
 
 ## Arduino-based puzzle modules
 
-Because of the poorly designed hardware (21-22) used during development
-(23-24), some puzzle modules ended up being developed using Arduino boards. All
-libraries in this repository use CMake for building (for consistency), which
-also means the Arduino based puzzle modules use CMake. The CMakeLists.txt of
-some puzzles uses the [Arduino-CMake-Toolchain][arduino-cmake]. To build any of
-these subfolders, make sure you have done the following:
+> [!NOTE]
+> Because of the poorly designed hardware (21-22) used during development
+> (23-24), all puzzle modules ended up being developed using Arduino boards.
+
+All libraries in this repository use CMake for building (for consistency),
+which also means the Arduino based puzzle modules use CMake. The CMakeLists.txt
+of some puzzles uses the [Arduino-CMake-Toolchain][arduino-cmake]. To build any
+of these subfolders, make sure you have done the following:
 
 - Install the official Arduino IDE
 - Open "Tools" > "Board" > "Board manager"
diff --git a/puzzle/vault/index.dox b/puzzle/vault/index.dox
new file mode 100644
index 0000000..b14e616
--- /dev/null
+++ b/puzzle/vault/index.dox
@@ -0,0 +1,6 @@
+// vim:ft=doxygen
+/**
+\ingroup puz
+\defgroup puz_vault Vault
+\brief Vault puzzle module
+*/
-- 
cgit v1.2.3