From 3ac145c1ff74bce84795b1acfea17f0c2ff7ea78 Mon Sep 17 00:00:00 2001 From: Mindy Date: Thu, 16 May 2019 17:48:26 -0400 Subject: [PATCH] add some docstrings for host type options --- packet.mli | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/packet.mli b/packet.mli index 2673546..6867025 100644 --- a/packet.mli +++ b/packet.mli @@ -1,7 +1,12 @@ type port = int type host = - [ `Client of Fw_utils.client_link | `Client_gateway | `Firewall_uplink | `NetVM | `External of Ipaddr.t ] + [ `Client of Fw_utils.client_link (** an IP address on the private network *) + | `Client_gateway (** the firewall's IP on the private network *) + | `Firewall_uplink (** the firewall's IP on the public network *) + | `NetVM (** the IP of the firewall's default route *) + | `External of Ipaddr.t (** an IP on the public network *) + ] type transport_header = [`TCP of Tcp.Tcp_packet.t |`UDP of Udp_packet.t