feat(SPV-851) fix function descriptions to one-liners

examples/example_keys.go

@@ -25,9 +25,7 @@ const (
 	ExamplePaymail string = ""
 )
 
-/*
-GenerateKeys - function for generating keys (private and public)
-*/
+// GenerateKeys - function for generating keys (private and public)
 func GenerateKeys() xpriv.KeyWithMnemonic {
 	keys, err := xpriv.Generate()
 	if err != nil {

examples/utils.go

@@ -11,16 +11,12 @@ import (
 // 'xPriv' | 'xPub' | 'adminKey' | 'Paymail'
 type keyType string
 
-/*
-ErrMessage - function for displaying errors about missing keys (see CheckIfAdminKeyExists, CheckIfXPrivExists)
-*/
+// ErrMessage - function for displaying errors about missing keys (see CheckIfAdminKeyExists, CheckIfXPrivExists)
 func ErrMessage(key keyType) string {
 	return fmt.Sprintf("Please provide a valid %s.", key)
 }
 
-/*
-HandlePanic - function used to handle a recovery after a panic - use with defer
-*/
+// HandlePanic - function used to handle a recovery after a panic - use with defer
 func HandlePanic() {
 	r := recover()
 
@@ -29,29 +25,23 @@ func HandlePanic() {
 	}
 }
 
-/*
-CheckIfXPrivExists - checks if ExampleXPriv is not empty
-*/
+// CheckIfXPrivExists - checks if ExampleXPriv is not empty
 func CheckIfXPrivExists() {
 	if ExampleXPriv == "" {
 		fmt.Println(ErrMessage("xPriv"))
 		os.Exit(1)
 	}
 }
 
-/*
-CheckIfXPubExists - checks if ExampleXPub is not empty
-*/
+// CheckIfXPubExists - checks if ExampleXPub is not empty
 func CheckIfXPubExists() {
 	if ExampleXPub == "" {
 		fmt.Println(ErrMessage("xPub"))
 		os.Exit(1)
 	}
 }
 
-/*
-CheckIfAdminKeyExists - checks if ExampleAdminKey is not empty
-*/
+// CheckIfAdminKeyExists - checks if ExampleAdminKey is not empty
 func CheckIfAdminKeyExists() {
 	if ExampleAdminKey == "" {
 		fmt.Println(ErrMessage("adminKey"))