doc: add package-level doc comments (#9)
This commit is contained in:
2
internal/gen/doc.go
Normal file
2
internal/gen/doc.go
Normal file
@@ -0,0 +1,2 @@
|
||||
// Package gen provides code generators based on the instruction database.
|
||||
package gen
|
||||
2
internal/inst/doc.go
Normal file
2
internal/inst/doc.go
Normal file
@@ -0,0 +1,2 @@
|
||||
// Package inst is the avo instruction database.
|
||||
package inst
|
||||
2
internal/load/doc.go
Normal file
2
internal/load/doc.go
Normal file
@@ -0,0 +1,2 @@
|
||||
// Package load loads the instruction database from external sources.
|
||||
package load
|
||||
2
internal/opcodescsv/doc.go
Normal file
2
internal/opcodescsv/doc.go
Normal file
@@ -0,0 +1,2 @@
|
||||
// Package opcodescsv extracts data from the Go x86.csv database.
|
||||
package opcodescsv
|
||||
@@ -1,3 +1,4 @@
|
||||
// Package opcodesxml is a reader for the Opcodes XML database.
|
||||
package opcodesxml
|
||||
|
||||
import (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
// Package prnt provides common functionality for code generators.
|
||||
package prnt
|
||||
|
||||
import (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
// Package stack provides helpers for querying the callstack.
|
||||
package stack
|
||||
|
||||
import (
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
// Package test provides testing utilities.
|
||||
package test
|
||||
|
||||
import (
|
||||
|
||||
Reference in New Issue
Block a user