Expand HTTP server docs

Author: danschultzer

lib/test_server.ex

@@ -429,7 +429,7 @@ defmodule TestServer do
   @doc """
   Adds a route to a test server instance.
 
-  See `plug/1` for options.
+  See `plug/1` for more.
   """
   @spec plug(pid(), module() | function()) :: :ok
   def plug(instance, plug) do
@@ -459,6 +459,8 @@ defmodule TestServer do
 
   @doc """
   Fetches the generated x509 suite for a test server instance.
+
+  See `x509_suite/0` for more.
   """
   @spec x509_suite(pid()) :: term()
   def x509_suite(instance) do

lib/test_server/http_server/bandit.ex

@@ -1,12 +1,23 @@
 if Code.ensure_loaded?(Bandit) do
   defmodule TestServer.HTTPServer.Bandit do
-    @moduledoc false
+    @moduledoc """
+    HTTP server adapter using `Bandit`.
 
-    alias TestServer.WebSocket
+    By default only one acceptor process is started which is enough for
+    testing. This adapter will be used by default if `Bandit` is loaded in the
+    project.
+
+    ## Usage
 
+        TestServer.start(
+          http_server: {TestServer.HTTPServer.Bandit, bandit_options}
+        )
+    """
     @behaviour TestServer.HTTPServer
     @behaviour WebSock
 
+    alias TestServer.WebSocket
+
     @impl TestServer.HTTPServer
     def start(instance, port, scheme, options, bandit_options) do
       transport_options =

lib/test_server/http_server/httpd.ex

@@ -1,7 +1,17 @@
 if Code.ensure_loaded?(:httpd) do
   defmodule TestServer.HTTPServer.Httpd do
-    @moduledoc false
+    @moduledoc """
+    HTTP server adapter using `:httpd`.
 
+    This adapter will be used by default if there is no `Bandit` or
+    `Plug.Cowboy` loaded in the project.
+
+    ## Usage
+
+        TestServer.start(
+          http_server: {TestServer.HTTPServer.Httpd, httpd_options}
+        )
+    """
     @behaviour TestServer.HTTPServer
 
     @impl TestServer.HTTPServer
@@ -42,12 +52,13 @@ if Code.ensure_loaded?(:httpd) do
     # :httpd record handler
     require Record
 
-    Record.defrecord(
+    Record.defrecordp(
       :httpd,
       Record.extract(:mod, from_lib: "inets/include/httpd.hrl") ++
         [handler_plug: :undefined, websocket: :undefined]
     )
 
+    @doc false
     def unquote(:do)(data) do
       {plug, opts} = :httpd_util.lookup(httpd(data, :config_db), :handler_plug)
 

lib/test_server/http_server/plug_cowboy.ex

@@ -1,6 +1,17 @@
 if Code.ensure_loaded?(Plug.Cowboy) do
   defmodule TestServer.HTTPServer.Plug.Cowboy do
-    @moduledoc false
+    @moduledoc """
+    HTTP server adapter using `Plug.Cowboy`.
+
+    This adapter will be used by default if `Bandit` is not loaded and
+    `Plug.Cowboy` is loaded in the project.
+
+    ## Usage
+
+        TestServer.start(
+          http_server: {TestServer.HTTPServer.Plug.Cowboy, cowboy_options}
+        )
+    """
 
     # Server
 

mix.exs

@@ -75,6 +75,14 @@ defmodule TestServer.MixProject do
       ],
       skip_undefined_reference_warnings_on: [
         "CHANGELOG.md"
+      ],
+      groups_for_modules: [
+        HTTPServer: [
+          TestServer.HTTPServer,
+          TestServer.HTTPServer.Httpd,
+          TestServer.HTTPServer.Bandit,
+          TestServer.HTTPServer.Plug.Cowboy
+        ]
       ]
     ]
   end