summaryrefslogtreecommitdiff
path: root/types/protocol/protocol.go
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2023-03-21 14:53:03 +0100
committerJeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com>2023-09-25 09:43:37 +0200
commitd292630dff02f0a5ef4d268e41464b52543a72e9 (patch)
treefb8c46ffde5eababad4f94e389429f00cfa3d246 /types/protocol/protocol.go
parent852b67390ec286af6ef795b05e00f0afe1c56709 (diff)
Types: Add comments describing the fields, types, packages and functions
Diffstat (limited to 'types/protocol/protocol.go')
-rw-r--r--types/protocol/protocol.go3
1 files changed, 3 insertions, 0 deletions
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":