Permalink
Browse files

Improved the docstring on run-jetty

  • Loading branch information...
weavejester committed Oct 29, 2011
1 parent 1ce02b7 commit bbd36d0a0af08529d417b8b13e48f29c6948c680
Showing with 13 additions and 12 deletions.
  1. +13 −12 ring-jetty-adapter/src/ring/adapter/jetty.clj
@@ -47,18 +47,19 @@
server))
(defn ^Server run-jetty
- "Serve the given handler according to the options.
- Options:
- :configurator - A function called with the Server instance.
- :port
- :host
- :join? - Block the caller: defaults to true.
- :ssl? - Use SSL.
- :ssl-port - SSL port: defaults to 443, implies :ssl?
- :keystore
- :key-password
- :truststore
- :trust-password"
+ "Start a Jetty webserver to serve the given handler according to the
+ supplied options:
+
+ :configurator - a function called with the Jetty Server instance
+ :port - the port to listen on (defaults to 80)
+ :host - the hostname to listen on
+ :join? - blocks the thread until server ends (defaults to true)
+ :ssl? - allow connections over HTTPS
+ :ssl-port - the SSL port to listen on (defaults to 443, implies :ssl?)
+ :keystore - the keystore to use for SSL connections
+ :key-password - the password to the keystore
+ :truststore - a truststore to use for SSL connections
+ :trust-password - the password to the truststore"
[handler options]
(let [^Server s (create-server (dissoc options :configurator))]
(when-let [configurator (:configurator options)]

0 comments on commit bbd36d0

Please sign in to comment.