From 4cc3292d6c59e48f22cbcaae0ee2773c22c2bad9 Mon Sep 17 00:00:00 2001
From: Baylac-Jacqué Félix <felix@alternativebit.fr>
Date: Sat, 16 Sep 2017 16:54:24 +0200
Subject: Document RPC-related modules.

---
 src/Network/WireGuard/Internal/Data/RpcTypes.hs | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src/Network/WireGuard/Internal/Data/RpcTypes.hs')

diff --git a/src/Network/WireGuard/Internal/Data/RpcTypes.hs b/src/Network/WireGuard/Internal/Data/RpcTypes.hs
index 7e1c20e..d3ec964 100644
--- a/src/Network/WireGuard/Internal/Data/RpcTypes.hs
+++ b/src/Network/WireGuard/Internal/Data/RpcTypes.hs
@@ -1,3 +1,15 @@
+{-|
+Module      : Network.WireGuard.Internal.Data.RpcTypes
+Description : Collection of types used to communicate with the wg CLI utility.
+Copyright   : Félix Baylac-Jacqué, 2017
+License     : GPL-3
+Maintainer  : felix@alternativebit.fr
+Stability   : experimental
+Portability : POSIX
+
+Collection of types used by to communicate with the wg CLI utility.
+|-}
+
 module Network.WireGuard.Internal.Data.RpcTypes(
  OpType(..),
  RpcRequest(..),
@@ -51,6 +63,7 @@ instance Eq RpcDevicePayload where
       ((dhSecToBytes . fst) <$> pk1) == ((dhSecToBytes . fst) <$> pk2) && (prt1 == prt2) &&
       (rp1 == rp2) && (fw1 == fw2)
 
+-- | Key/Value couple of set device operations.
 data RpcDeviceField = RpcPk !(Maybe KeyPair)
                     | RpcPort !Int
                     | RpcFwMark !(Maybe Word)
@@ -77,6 +90,7 @@ instance Show RpcPeerPayload where
     = show (dhPubToBytes pub1) ++ show rm1 ++ show psk1 ++ show e1 ++ show k1 ++ 
       show rp1 ++ show aip1
 
+-- | Key/Value couple of set peer operations.
 data RpcPeerField = RpcRmFlag    !Bool
                   | RpcPsh       !PresharedKey
                   | RpcEndp      !SockAddr
-- 
cgit v1.2.3-59-g8ed1b