From ee4169faf487e0d4d75738fdddb34cc1767719f9 Mon Sep 17 00:00:00 2001
From: Clombrong <cromblong@egregore.fun>
Date: Sun, 29 Jun 2025 18:31:55 +0200
Subject: docs(starttls): add for config type

---
 lib/starttls.ml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lib/starttls.ml b/lib/starttls.ml
index fafda66..9d09e3e 100644
--- a/lib/starttls.ml
+++ b/lib/starttls.ml
@@ -1,6 +1,10 @@
 open Lwt.Syntax
 open Xml
 
+(** This type is used to configure the STARTTLS handshake during the stream negotiation.
+
+    When the XMPP server advertises optional STARTTLS support, whether the connection
+    will be upgraded to STARTTLS depends on [prefer_starttls]. *)
 type config = {
     prefer_starttls : bool
   }
-- 
cgit v1.2.3