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
examples/add/doc.go Normal file
View File

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

2
examples/args/doc.go Normal file
View File

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

2
examples/complex/doc.go Normal file
View File

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

2
examples/data/doc.go Normal file
View File

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

2
examples/dot/doc.go Normal file
View File

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

2
examples/fnv1a/doc.go Normal file
View File

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

2
examples/geohash/doc.go Normal file
View File

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

2
examples/returns/doc.go Normal file
View File

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

2
examples/sha1/doc.go Normal file
View File

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

2
examples/sum/doc.go Normal file
View File

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