docs: improve go doc comments for vm package

This commit is contained in:
5684185+vsariola@users.noreply.github.com 2023-10-19 11:54:12 +03:00
parent 98a73795c7
commit e010b2da9d
3 changed files with 7 additions and 2 deletions

5
vm/doc.go Normal file
View File

@ -0,0 +1,5 @@
/*
Package vm implements a virtual machine based synthesizer that runs Sointu
bytecode, and methods to convert patches into bytecode.
*/
package vm

View File

@ -21,9 +21,9 @@ func main() {
outputFile, err := os.Create("opcodes.go")
check(err)
defer outputFile.Close()
fmt.Fprintln(outputFile, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(outputFile, "package vm")
fmt.Fprintln(outputFile, "")
fmt.Fprintln(outputFile, "// Code generated by go generate; DO NOT EDIT.")
fmt.Fprintln(outputFile, "const (")
features := vm.AllFeatures{}
max := 0

View File

@ -1,6 +1,6 @@
// Code generated by go generate; DO NOT EDIT.
package vm
// Code generated by go generate; DO NOT EDIT.
const (
opAdd = 1
opAddp = 2