lib/generators: add manual documentation

Restructures the functions reference a bit.
2016-11-17 22:29:32 +01:00
parent 26eb10e771
commit 53fc7b8272
2 changed files with 428 additions and 380 deletions
--- a/lib/generators.nix
+++ b/lib/generators.nix
@@ -1,6 +1,11 @@
-/* Functions that generate widespread config file
+/* Functions that generate widespread file
 * formats from nix data structures.
+ *
+ * They all follow a similar interface:
+ * generator { config-attrs } data
+ *
 * Tests can be found in ./tests.nix
+ * Documentation in the manual, #sec-generators
 */
 with import ./trivial.nix;
 let