docs(portal): document Portal.t

1 files changed, 6 insertions, 0 deletions

diff --git a/portal/portal.mli b/portal/portal.mli
index a9810cd..2f52547 100644
--- a/portal/portal.mli
+++ b/portal/portal.mli
@@ -4,6 +4,12 @@ exception MalformedStanza of location * Error.t
 
 type socket
 
+(** The type of portals communicating with an XMPP server via [_socket].
+
+    [stream] is the data sent by the XMPP server.
+
+    [push None] disconnects brutally the underlying XMPP server and closes [_socket],
+    without closing the element stream first. *)
 type t = {
     stream : (signal, async) stream;
     push : (signal, sync) stream option -> unit;