docs: describe file structure for implementations

jenspots · Apr 14, 2024 · 03c9be0 · 03c9be0
1 parent bb73d3e
commit 03c9be0
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/include/wheel/containers/README.md b/include/wheel/containers/README.md
@@ -12,3 +12,14 @@ The following data structures are implemented. Note that some require the use of
 | Stack                 | `stack`      | None                     | Unstable |
 | Trie                  | `trie`       | None                     | Unstable |
 | Vector                | `vec`        | None                     | Unstable |
+
+### Structure
+
+All container implementation follow the same file structure.
+
+| File       | Description                                                                                   |
+|------------|-----------------------------------------------------------------------------------------------|
+| `def.h`    | Introduce the keywords into the global namespace.                                             |
+| `header.h` | Header file for the specific data structure which may be included multiple times.             |
+| `impl.h`   | Implementation of the data structure. This file may only be included once per `LIBWHEEL_TYPE` |
+| `undef.h`  | Undefine the keywords introduced by `def.h`.                                                  |