diff options
| author | Clombrong <cromblong@egregore.fun> | 2025-06-27 08:24:25 +0200 |
|---|---|---|
| committer | Clombrong <cromblong@egregore.fun> | 2025-06-27 08:56:42 +0200 |
| commit | dc434b813d7f438954f938108bf5edd911173f18 (patch) | |
| tree | 76bfd24a17aa6680cb7872977a5bad7ee4b244b0 | |
| parent | 79d15a2baec54f10ba5114667d3d686982a90bee (diff) | |
docs(portal): add docstring to connect
| -rw-r--r-- | portal/portal.mli | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index 5efc355..758893e 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -28,4 +28,5 @@ val header : ?from:string -> string -> t -> string Lwt.t any way: It's the caller's job to provide it to the stream. *) val close : (signal, sync) stream +(** [connect domain] returns a Portal connected to the XMPP server [domain]. *) val connect : string -> t Lwt.t |