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

build/doc.go

@@ -0,0 +1,2 @@
+// Package build provides an assembly-like interface for incremental building of avo Files.
+package build

doc.go

@@ -0,0 +1,2 @@
+// Package avo is a high-level x86 assembly generator.
+package avo

examples/add/doc.go

@@ -0,0 +1,2 @@
+// Package add demonstrates an Add function in avo.
+package add

examples/args/doc.go

@@ -0,0 +1,2 @@
+// Package args demonstrates how to load function arguments in avo.
+package args

examples/complex/doc.go

@@ -0,0 +1,2 @@
+// Package complex shows how to work with complex types in avo.
+package complex

examples/data/doc.go

@@ -0,0 +1,2 @@
+// Package data shows how to define DATA sections in avo.
+package data

examples/dot/doc.go

@@ -0,0 +1,2 @@
+// Package dot implements vector dot product in avo.
+package dot

examples/fnv1a/doc.go

@@ -0,0 +1,2 @@
+// Package fnv1a implements FNV-1a in avo.
+package fnv1a

examples/geohash/doc.go

@@ -0,0 +1,2 @@
+// Package geohash implements integer geohash encoding in avo.
+package geohash

examples/returns/doc.go

@@ -0,0 +1,2 @@
+// Package returns demonstrates how to write function return values in avo.
+package returns

examples/sha1/doc.go

@@ -0,0 +1,2 @@
+// Package sha1 implements the SHA-1 hash in avo.
+package sha1

examples/sum/doc.go

@@ -0,0 +1,2 @@
+// Package sum sums a slice in avo.
+package sum

internal/gen/doc.go

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

internal/inst/doc.go

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

internal/load/doc.go

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

internal/opcodescsv/doc.go

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

internal/opcodesxml/opcodesxml.go

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

internal/prnt/printer.go

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

internal/stack/stack.go

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

internal/test/utils.go

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

operand/doc.go

@@ -0,0 +1,2 @@
+// Package operand provides types for instruction operands.
+package operand

reg/doc.go

@@ -0,0 +1,2 @@
+// Package reg provides types for physical and virtual registers, and definitions of x86-64 register families.
+package reg

tests/cast/doc.go

@@ -0,0 +1,2 @@
+// Package cast tests casting virtual registers to different sizes.
+package cast

tests/textflag/doc.go

@@ -0,0 +1,2 @@
+// Package textflag tests that avo attribute constants agree with textflag.h.
+package textflag

x86/doc.go

@@ -0,0 +1,2 @@
+// Package x86 provides constructors for all x86-64 instructions.
+package x86