go-vise

commit 5e8cacd7bc63ba7f76680510d2268a20f8635f25
parent 12ff703bc962911dad0f7c5e86ee7584cd64e966
Author: lash <dev@holbrook.no>
Date:   Thu, 13 Apr 2023 09:56:31 +0100

Add package documentation comments

Diffstat:
A
cache/doc.go
 | 
2
++
A
dev/asm/doc.go
 | 
2
++
A
dev/disasm/doc.go
 | 
2
++
A
dev/gendata/doc.go
 | 
2
++
A
dev/interactive/doc.go
 | 
2
++
A
engine/doc.go
 | 
2
++
A
persist/doc.go
 | 
2
++
A
render/doc.go
 | 
2
++
A
resource/doc.go
 | 
2
++

9 files changed, 18 insertions(+), 0 deletions(-)
diff --git a/cache/doc.go b/cache/doc.go
@@ -0,0 +1,2 @@
+// Package cache is a memory store for key-value pairs for all loaded symbols available for output.
+package cache
diff --git a/dev/asm/doc.go b/dev/asm/doc.go
@@ -0,0 +1,2 @@
+// Executable asm compiles festival assembly code to bytecode instructions.
+package main
diff --git a/dev/disasm/doc.go b/dev/disasm/doc.go
@@ -0,0 +1,2 @@
+// Executable disasm generates festival assembly code from bytecode instructions.
+package main
diff --git a/dev/gendata/doc.go b/dev/gendata/doc.go
@@ -0,0 +1,2 @@
+// Execution gendata output testdata provisions compatible with resource.FsResource to a filesystem directory.
+package main
diff --git a/dev/interactive/doc.go b/dev/interactive/doc.go
@@ -0,0 +1,2 @@
+// Executable interactive runs the Engine execution loop against interactive client input in the terminal.
+package main
diff --git a/engine/doc.go b/engine/doc.go
@@ -0,0 +1,2 @@
+// Package engine orchestrates client input with vm execution.
+package engine
diff --git a/persist/doc.go b/persist/doc.go
@@ -0,0 +1,2 @@
+// Package persist enables persistent storage of the execution state.
+package persist
diff --git a/render/doc.go b/render/doc.go
@@ -0,0 +1,2 @@
+// Package render handles output size constraints and paginated rendering of contents and menus against templates.
+package render
diff --git a/resource/doc.go b/resource/doc.go
@@ -0,0 +1,2 @@
+// Package resource interfaces retrieval of bytecode, output templates and external code execution.
+package resource