mirror/sointu
1
0
Fork 0
mirror of https://github.com/vsariola/sointu.git synced 2025-05-28 03:10:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve go doc comments for vm package

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

2
vm/generate/generate.go
View File

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

2
vm/opcodes.go
View File

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