From d292630dff02f0a5ef4d268e41464b52543a72e9 Mon Sep 17 00:00:00 2001
From: jwijenbergh <jeroenwijenbergh@protonmail.com>
Date: Tue, 21 Mar 2023 14:53:03 +0100
Subject: Types: Add comments describing the fields, types,  packages and
 functions

---
 types/protocol/protocol.go | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'types/protocol/protocol.go')

diff --git a/types/protocol/protocol.go b/types/protocol/protocol.go
index 6e003f7..e35de2b 100644
--- a/types/protocol/protocol.go
+++ b/types/protocol/protocol.go
@@ -1,5 +1,7 @@
+// package protocol contains hte public type that have to do with VPN protocols
 package protocol
 
+// Protocol defines an 'enumeration' of protocols
 type Protocol int8
 
 const (
@@ -11,6 +13,7 @@ const (
 	WireGuard
 )
 
+// New creates a new protocol type from a string
 func New(p string) Protocol {
 	switch p {
 	case "openvpn":
-- 
cgit v1.2.3