[doc] [Community adapters] Improve constructor docstrings

Author: ptaoussanis

src/taoensso/sente/server_adapters/community/aleph.clj

@@ -1,6 +1,4 @@
 (ns taoensso.sente.server-adapters.community.aleph
-  "Sente server adapter for Aleph,
-  Ref. <https://github.com/clj-commons/aleph>."
   {:author "Soren Macbeth (@sorenmacbeth)"}
   (:require
    [taoensso.sente.interfaces :as i]
@@ -44,7 +42,10 @@
           {:body s})))))
 
 (defn get-sch-adapter
-  "Supports websocket-connection options in `aleph.http`.
-  If no option map is provided, the default options apply."
+  "Returns a Sente `ServerChan` adapter for `Aleph`,
+  Ref. <https://github.com/clj-commons/aleph>.
+
+  Supports websocket-connection options as in `aleph.http`.
+  If no options map is provided, the default options apply."
   ([    ] (AlephAsyncNetworkChannelAdapter. nil))
   ([opts] (AlephAsyncNetworkChannelAdapter. opts)))

src/taoensso/sente/server_adapters/community/immutant.clj

@@ -1,6 +1,4 @@
 (ns taoensso.sente.server-adapters.community.immutant
-  "Sente server adapter for Immutant v2+,
-  Ref. <https://github.com/immutant/immutant>."
   {:author "Toby Crawley (@tobias)"}
   (:require
    [taoensso.encore :as enc]
@@ -31,7 +29,10 @@
                        (fn [sch {:keys [code reason] :as status-map}]
                          (on-close sch ws? status-map)))))))
 
-(defn get-sch-adapter [] (ImmutantServerChanAdapter.))
+(defn get-sch-adapter
+  "Returns a Sente `ServerChan` adapter for `Immutant` v2+,
+  Ref. <https://github.com/immutant/immutant>."
+  [] (ImmutantServerChanAdapter.))
 
 (enc/deprecated
   (defn ^:deprecated ^:no-doc make-immutant-adapter [_opts] (get-sch-adapter))

src/taoensso/sente/server_adapters/community/jetty.clj

@@ -1,7 +1,4 @@
 (ns taoensso.sente.server-adapters.community.jetty
-  "Sente adapter for `ring-jetty-adapter`,
-  Ref. <https://github.com/ring-clojure/ring/tree/master/ring-jetty-adapter>.
-  Adapted from <https://github.com/taoensso/sente/pull/426#issuecomment-1647231979>."
   {:author "Alex Gunnarson (@alexandergunnarson)"}
   (:require
     [ring.core.protocols       :as ring-protocols]
@@ -104,8 +101,14 @@
       (ring-response/response (ajax-ch callbacks-map adapter-opts)))))
 
 (defn get-sch-adapter
-  "Returns an Jetty ServerChanAdapter. Options:
-     `:ajax-resp-timeout-ms` - Max msecs to wait for Ajax responses (default 60 secs)"
+  "Returns a Sente `ServerChan` adapter for `ring-jetty-adapter` [1].
+  Supports Jetty 11.
+
+  Options:
+     `:ajax-resp-timeout-ms` - Max msecs to wait for Ajax responses (default 60 secs),
+                               exception thrown on timeout.
+
+  [1] Ref. <https://github.com/ring-clojure/ring/tree/master/ring-jetty-adapter>."
   ([] (get-sch-adapter nil))
   ([{:as   opts
      :keys [ajax-resp-timeout-ms]

src/taoensso/sente/server_adapters/community/nginx_clojure.clj

@@ -1,7 +1,5 @@
 (ns ^:no-doc taoensso.sente.server-adapters.community.nginx-clojure
   ;; `^:no-doc` needed to prevent broken cljdoc build
-  "Sente server adapter for Nginx-Clojure v0.4.2+.
-  Ref. <https://github.com/nginx-clojure/nginx-clojure>."
   {:author "Zhang Yuexiang (@xfeep)"}
   (:require
    [taoensso.encore :as enc]
@@ -48,7 +46,10 @@
 
       {:status 200 :body sch})))
 
-(defn get-sch-adapter [] (NginxServerChanAdapter.))
+(defn get-sch-adapter
+    "Returns a Sente `ServerChan` adapter for `Nginx-Clojure` v0.4.2+.
+  Ref. <https://github.com/nginx-clojure/nginx-clojure>."
+  [] (NginxServerChanAdapter.))
 
 (enc/deprecated
   (def ^:deprecated ^:no-doc nginx-clojure-adapter (get-sch-adapter))

src/taoensso/sente/server_adapters/community/undertow.clj

@@ -1,6 +1,4 @@
 (ns taoensso.sente.server-adapters.community.undertow
-  "Sente server adapter for ring-undertow-adapter,
-  Ref. <https://github.com/luminus-framework/ring-undertow-adapter>."
   {:author "Nik Peric"}
   (:require
     [ring.adapter.undertow.websocket :as websocket]
@@ -89,8 +87,13 @@
        (ajax-ch callbacks-map adapter-opts))}))
 
 (defn get-sch-adapter
-  "Returns an Undertow ServerChanAdapter. Options:
-     `:ajax-resp-timeout-ms` - Max msecs to wait for Ajax responses (default 60 secs)"
+  "Returns a Sente `ServerChan` adapter for `ring-undertow-adapter` [1].
+
+  Options:
+     `:ajax-resp-timeout-ms` - Max msecs to wait for Ajax responses (default 60 secs),
+                               exception thrown on timeout.
+
+  [1] Ref. <https://github.com/luminus-framework/ring-undertow-adapter>."
   ([] (get-sch-adapter nil))
   ([{:as   opts
      :keys [ajax-resp-timeout-ms]