Add package documentation comments

This commit is contained in:
lash 2023-04-13 09:56:31 +01:00
parent 12ff703bc9
commit 5e8cacd7bc
Signed by untrusted user who does not match committer: lash
GPG Key ID: 21D2E7BB88C2A746
9 changed files with 18 additions and 0 deletions

2
cache/doc.go vendored Normal file
View File

@ -0,0 +1,2 @@
// Package cache is a memory store for key-value pairs for all loaded symbols available for output.
package cache

2
dev/asm/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Executable asm compiles festival assembly code to bytecode instructions.
package main

2
dev/disasm/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Executable disasm generates festival assembly code from bytecode instructions.
package main

2
dev/gendata/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Execution gendata output testdata provisions compatible with resource.FsResource to a filesystem directory.
package main

2
dev/interactive/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Executable interactive runs the Engine execution loop against interactive client input in the terminal.
package main

2
engine/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Package engine orchestrates client input with vm execution.
package engine

2
persist/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Package persist enables persistent storage of the execution state.
package persist

2
render/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Package render handles output size constraints and paginated rendering of contents and menus against templates.
package render

2
resource/doc.go Normal file
View File

@ -0,0 +1,2 @@
// Package resource interfaces retrieval of bytecode, output templates and external code execution.
package resource