From 1a8a3174644b1f9240bc917433730d1f0e2d1dcb Mon Sep 17 00:00:00 2001 From: "5684185+vsariola@users.noreply.github.com" <5684185+vsariola@users.noreply.github.com> Date: Thu, 19 Oct 2023 21:38:47 +0300 Subject: [PATCH] docs(tracker): improve package go doc comments --- tracker/doc.go | 4 ++++ tracker/generate/main.go | 2 +- tracker/gmdlsentries.go | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 tracker/doc.go diff --git a/tracker/doc.go b/tracker/doc.go new file mode 100644 index 0000000..1532c69 --- /dev/null +++ b/tracker/doc.go @@ -0,0 +1,4 @@ +/* +Package tracker contains the data model for the Sointu tracker GUI. +*/ +package tracker diff --git a/tracker/generate/main.go b/tracker/generate/main.go index 5a506fe..9a0c3f6 100644 --- a/tracker/generate/main.go +++ b/tracker/generate/main.go @@ -124,9 +124,9 @@ func main() { outputFile, err := os.Create("gmdlsentries.go") check(err) defer outputFile.Close() - fmt.Fprintln(outputFile, "// Code generated by go generate; DO NOT EDIT.") fmt.Fprintln(outputFile, "package tracker") fmt.Fprintln(outputFile, "") + fmt.Fprintln(outputFile, "// Code generated by go generate; DO NOT EDIT.") fmt.Fprintln(outputFile, "var GmDlsEntries = []GmDlsEntry{") readChunk(0, inputFile, &gmDlsVisitor{outputFile: outputFile}) fmt.Fprintln(outputFile, "}") diff --git a/tracker/gmdlsentries.go b/tracker/gmdlsentries.go index 781138d..cb86fa8 100644 --- a/tracker/gmdlsentries.go +++ b/tracker/gmdlsentries.go @@ -1,6 +1,6 @@ -// Code generated by go generate; DO NOT EDIT. package tracker +// Code generated by go generate; DO NOT EDIT. var GmDlsEntries = []GmDlsEntry{ {Start: 140078, LoopStart: 1353, LoopLength: 91, SuggestedTranspose: 1, Name: "101BS35"}, {Start: 141606, LoopStart: 1380, LoopLength: 43, SuggestedTranspose: -12, Name: "101BS48"},