added docs

nirokay · Sep 24, 2024 · 4312726 · 4312726
1 parent 6f188fb
commit 4312726
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/websitegenerator/attributes.nim b/websitegenerator/attributes.nim
@@ -1,3 +1,6 @@
+## Attributes Module
+## =================
+##
 ## Automatically generated procs for setting single HTML attributes
 ##
 ## Reference:

diff --git a/websitegenerator/attributes/generateFromCsv.nim b/websitegenerator/attributes/generateFromCsv.nim
@@ -1,8 +1,18 @@
+## Attributes Generator
+## ====================
+##
+## This module automatically generates setters for HTML attributes from parsing a CSV file, so that
+## I do not have to type them out manually and when there are news ones from new HTML versions, it
+## can be easily extended.
+
 import std/[strutils, strformat, parsecsv, tables]
 
 const targetFile: string = "../attributes.nim"
 
 var lines: seq[string] = @[
+    "## Attributes Module",
+    "## =================",
+    "##",
     "## Automatically generated procs for setting single HTML attributes",
     "##",
     "## Reference:",

diff --git a/websitegenerator/mimetypes/generateFromCsv.nim b/websitegenerator/mimetypes/generateFromCsv.nim
@@ -1,3 +1,9 @@
+## Mimetype Generator
+## ==================
+##
+## This module reads a csv file and turns it into valid Nim code, so my fingers do not die from
+## typing every single Mimetype by hand.
+
 import std/[strutils, strformat]
 
 const files: seq[string] = @[