Permalink
Browse files

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

  • Loading branch information...
mmcloughlin committed Jan 6, 2019
1 parent 0989c0d commit 5c67547d670eb31c66d94793474497f230f2765e
@@ -0,0 +1,2 @@
// Package build provides an assembly-like interface for incremental building of avo Files.
package build
2 doc.go
@@ -0,0 +1,2 @@
// Package avo is a high-level x86 assembly generator.
package avo
@@ -0,0 +1,2 @@
// Package add demonstrates an Add function in avo.
package add
@@ -0,0 +1,2 @@
// Package args demonstrates how to load function arguments in avo.
package args
@@ -0,0 +1,2 @@
// Package complex shows how to work with complex types in avo.
package complex
@@ -0,0 +1,2 @@
// Package data shows how to define DATA sections in avo.
package data
@@ -0,0 +1,2 @@
// Package dot implements vector dot product in avo.
package dot
@@ -0,0 +1,2 @@
// Package fnv1a implements FNV-1a in avo.
package fnv1a
@@ -0,0 +1,2 @@
// Package geohash implements integer geohash encoding in avo.
package geohash
@@ -0,0 +1,2 @@
// Package returns demonstrates how to write function return values in avo.
package returns
@@ -0,0 +1,2 @@
// Package sha1 implements the SHA-1 hash in avo.
package sha1
@@ -0,0 +1,2 @@
// Package sum sums a slice in avo.
package sum
@@ -0,0 +1,2 @@
// Package gen provides code generators based on the instruction database.
package gen
@@ -0,0 +1,2 @@
// Package inst is the avo instruction database.
package inst
@@ -0,0 +1,2 @@
// Package load loads the instruction database from external sources.
package load
@@ -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 (
@@ -0,0 +1,2 @@
// Package operand provides types for instruction operands.
package operand
@@ -0,0 +1,2 @@
// Package reg provides types for physical and virtual registers, and definitions of x86-64 register families.
package reg
@@ -0,0 +1,2 @@
// Package cast tests casting virtual registers to different sizes.
package cast
@@ -0,0 +1,2 @@
// Package textflag tests that avo attribute constants agree with textflag.h.
package textflag
@@ -0,0 +1,2 @@
// Package x86 provides constructors for all x86-64 instructions.
package x86

0 comments on commit 5c67547

Please sign in to comment.