doc: add package-level doc comments (#9)

This commit is contained in:
Michael McLoughlin
2019-01-05 17:23:56 -08:00
parent 0989c0daea
commit 5c67547d67
25 changed files with 46 additions and 0 deletions

2
internal/gen/doc.go Normal file
View File

@@ -0,0 +1,2 @@
// Package gen provides code generators based on the instruction database.
package gen

2
internal/inst/doc.go Normal file
View File

@@ -0,0 +1,2 @@
// Package inst is the avo instruction database.
package inst

2
internal/load/doc.go Normal file
View File

@@ -0,0 +1,2 @@
// Package load loads the instruction database from external sources.
package load

View File

@@ -0,0 +1,2 @@
// Package opcodescsv extracts data from the Go x86.csv database.
package opcodescsv

View File

@@ -1,3 +1,4 @@
// Package opcodesxml is a reader for the Opcodes XML database.
package opcodesxml
import (

View File

@@ -1,3 +1,4 @@
// Package prnt provides common functionality for code generators.
package prnt
import (

View File

@@ -1,3 +1,4 @@
// Package stack provides helpers for querying the callstack.
package stack
import (

View File

@@ -1,3 +1,4 @@
// Package test provides testing utilities.
package test
import (