Add comments to public functions

token/checks/checkAmount.go

@@ -4,6 +4,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/errs"
 )
 
+// CheckAmount is used to check
+// if the length of a token can be used.
 func CheckAmount(amount int) error {
 	if amount < 1 {
 		return errs.ErrAmount1

token/checks/checkEmojies.go

@@ -5,6 +5,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/errs"
 )
 
+// CheckEmojies is used to check
+// if enough emojies are specified.
 func CheckEmojies(emojies emojies.Emojies) error {
 	if len(emojies) < 1 {
 		return errs.ErrEmojies1

token/checks/checkPeriod.go

@@ -6,6 +6,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/errs"
 )
 
+// CheckPeriod is used to check
+// if the period of validity is long enough.
 func CheckPeriod(period time.Duration) error {
 	if period.Milliseconds() < 1000 {
 		return errs.ErrPeriod1

token/checks/checkSecret.go

@@ -2,6 +2,8 @@ package checks
 
 import "github.com/Mobilpadde/moths/v5/token/errs"
 
+// CheckSecret is used to check
+// if the provided secret is "strong" enough.
 func CheckSecret(secret string) error {
 	if len(secret) == 0 {
 		return errs.ErrSecretLength

token/code/newCode.go

@@ -11,6 +11,9 @@ import (
 
 const EmojiBytes = 4
 
+// NewCode creates a new code
+//
+// This is generally not for public usage.
 func NewCode(token string, amount int, em emojies.Emojies, createdAt time.Time, expiresAt time.Time) (Code, error) {
 	code, err := generateCode(token, amount, em)
 	if err != nil {

token/emojies/helper.go

@@ -2,6 +2,8 @@ package emojies
 
 import "unicode/utf8"
 
+// ToEmojies can be used to convert a
+// slice of strings to [Emojies].
 func ToEmojies(emojies []string) Emojies {
 	em := Emojies{}
 

token/newGenerator.go

@@ -6,6 +6,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/checks"
 )
 
+// NewGenerator creates a new token generator
+// with the given [Option]s.
 func NewGenerator(opts ...Option) (*Generator, error) {
 	m := &Generator{
 		amount: 6, // Defaults to `6` as most other TOTP codes are this length

token/optionAmount.go

@@ -4,6 +4,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/checks"
 )
 
+// OptionWithAmount is used to specify
+// the amount of emojies in a code.
 func OptionWithAmount(amount int) Option {
 	return func(m *Generator) error {
 		if err := checks.CheckAmount(amount); err != nil {

token/optionEmojies.go

@@ -5,6 +5,9 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/emojies"
 )
 
+// OptionWithEmojies is used to specify
+// which emojies that can be used in
+// any given code.
 func OptionWithEmojies(emojies emojies.Emojies) Option {
 	return func(m *Generator) error {
 		if err := checks.CheckEmojies(emojies); err != nil {

token/optionPeriod.go

@@ -6,6 +6,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/checks"
 )
 
+// OptionWithPeriod is used to specify
+// how long a code will remain valid.
 func OptionWithPeriod(period time.Duration) Option {
 	return func(m *Generator) error {
 		if err := checks.CheckPeriod(period); err != nil {

token/optionSecret.go

@@ -6,6 +6,8 @@ import (
 	"github.com/Mobilpadde/moths/v5/token/checks"
 )
 
+// OptionWithSecret is used to specify
+// the secret to generate codes from.
 func OptionWithSecret(secret string) Option {
 	return func(m *Generator) error {
 		if err := checks.CheckSecret(secret); err != nil {

token/optionTime.go

@@ -2,6 +2,11 @@ package token
 
 import "time"
 
+// OptionWithTime is used to specify
+// a custom time to generate code from.
+//
+// If none is specified, the current time
+// will be used.
 func OptionWithTime(t time.Time) Option {
 	return func(m *Generator) error {
 		m.timing.time = t