Skip to content

Commit

Permalink
docs: doc.go files for each package
Browse files Browse the repository at this point in the history
  • Loading branch information
randomshinichi committed Oct 10, 2019
1 parent b29a4e7 commit e2c56d4
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 0 deletions.
5 changes: 5 additions & 0 deletions account/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/*
Package account contains code for managing account keypairs as well as saving
them securely to disk.
*/
package account
6 changes: 6 additions & 0 deletions aeternity/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/*
Package aeternity is the SDK user-facing code, e.g. convenience functions,
helpers and utilities that one might want to use when creating/broadcasting
transactions.
*/
package aeternity
5 changes: 5 additions & 0 deletions binary/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/*
Package binary contains hashing/base encoding code shared throughout the
codebase.
*/
package binary
7 changes: 7 additions & 0 deletions models/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*
Package models holds Go-native structs that are not Transactions.
This could be every swagger response type, however in practice only a few of
those need to be implemented.
*/
package models
6 changes: 6 additions & 0 deletions naet/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/*
Package naet represents a connection to a Node or Compiler. It saves the caller
from having to deal with swagger generated types and returns native Go types
whenever possible.
*/
package naet
5 changes: 5 additions & 0 deletions transactions/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/*
Package transactions contains Go-native Tx structs and related code around
Transactions.
*/
package transactions

0 comments on commit e2c56d4

Please sign in to comment.