From a92113e341dbd7a35b2a87586b164c37369d6f42 Mon Sep 17 00:00:00 2001
From: Jakub <jakub@cuth.sk>
Date: Thu, 7 Mar 2019 14:23:38 +0100
Subject: [PATCH] format and comment

---
 crypto/attachment.go |  4 +---
 crypto/key.go        |  3 +--
 internal/armor.go    |  2 +-
 internal/common.go   | 15 +++++++++------
 4 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/crypto/attachment.go b/crypto/attachment.go
index 8f6e859..e1409d3 100644
--- a/crypto/attachment.go
+++ b/crypto/attachment.go
@@ -107,10 +107,9 @@ func (pm *PmCrypto) EncryptAttachmentLowMemory(estimatedSize int, fileName strin
 	return pm.encryptAttachment(estimatedSize, fileName, publicKey, 1<<20)
 }
 
-// Use: ios/android only
 // Helper method. Splits armored pgp session into key and packet data
+// Use: ios/android only
 func SplitArmor(encrypted string) (*models.EncryptedSplit, error) {
-
 	var err error
 
 	encryptedRaw, err := armorUtils.Unarmor(encrypted)
@@ -121,7 +120,6 @@ func SplitArmor(encrypted string) (*models.EncryptedSplit, error) {
 	encryptedReader := bytes.NewReader(encryptedRaw)
 
 	return SeparateKeyAndData(nil, encryptedReader, len(encrypted), -1)
-
 }
 
 // Use: ios/android only
diff --git a/crypto/key.go b/crypto/key.go
index 220fd28..7e23d58 100644
--- a/crypto/key.go
+++ b/crypto/key.go
@@ -112,10 +112,9 @@ func DecryptAttKey(kr *KeyRing, keyPacket string) (key *SymmetricKey, err error)
 	return
 }
 
+// SeparateKeyAndData from packets in a pgp session
 // Use: bridge, ios/android, go-pm-crypto, attachment.go, keyring.go
-// Separate key and data packets in a pgp session
 func SeparateKeyAndData(kr *KeyRing, r io.Reader, estimatedLength int, garbageCollector int) (outSplit *models.EncryptedSplit, err error) {
-
 	// For info on each, see: https://golang.org/pkg/runtime/#MemStats
 	packets := packet.NewReader(r)
 	outSplit = &models.EncryptedSplit{}
diff --git a/internal/armor.go b/internal/armor.go
index 93b105b..7ed9e14 100644
--- a/internal/armor.go
+++ b/internal/armor.go
@@ -5,6 +5,7 @@ import (
 	"strings"
 )
 
+// Unarmor from string
 func Unarmor(input string) (*armor.Block, error) {
 	io := strings.NewReader(input)
 	b, err := armor.Decode(io)
@@ -12,5 +13,4 @@ func Unarmor(input string) (*armor.Block, error) {
 		return nil, err
 	}
 	return b, nil
-
 }
diff --git a/internal/common.go b/internal/common.go
index 8116082..1b33c33 100644
--- a/internal/common.go
+++ b/internal/common.go
@@ -5,21 +5,24 @@ import (
 	"regexp"
 )
 
+// TrimNewlines removes a whitespace in the end of string (don't stop on linebreak)
 func TrimNewlines(input string) string {
 	var re = regexp.MustCompile(`(?m)[ \t]*$`)
 	return re.ReplaceAllString(input, "")
 }
 
-// Amount of seconds that a signature may be created after the verify time
-// Consistent with the 2 day slack allowed in the ProtonMail Email Parser
+// CreationTimeOffset stores amount of seconds that a signature may be created
+// after the verify time Consistent with the 2 day slack allowed in the
+// ProtonMail Email Parser
 const CreationTimeOffset = int64(60 * 60 * 24 * 2)
 
 const (
-	ARMOR_HEADER_VERSION = "Pmcrypto Golang 0.0.1 (" + constants.VERSION + ")"
-	ARMOR_HEADER_COMMENT = "https://protonmail.com"
+	armorHeaderVersion = "Pmcrypto Golang 0.0.1 (" + constants.VERSION + ")"
+	armorHeaderComment = "https://protonmail.com"
 )
 
+// ArmorHeaders from golang pm-crypto
 var ArmorHeaders = map[string]string{
-	"Version": ARMOR_HEADER_VERSION,
-	"Comment": ARMOR_HEADER_COMMENT,
+	"Version": armorHeaderVersion,
+	"Comment": armorHeaderComment,
 }