From 4023e7f4e429179fd9c2cce4487c33646c6bd327 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Thu, 14 Jan 2016 13:35:25 +0100
Subject: Convert the documentation to Asciidoc

A few small revisions were made, and Erlang.mk has been updated.
---
 doc/src/manual/cowboy_sub_protocol.asciidoc | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 doc/src/manual/cowboy_sub_protocol.asciidoc

(limited to 'doc/src/manual/cowboy_sub_protocol.asciidoc')

diff --git a/doc/src/manual/cowboy_sub_protocol.asciidoc b/doc/src/manual/cowboy_sub_protocol.asciidoc
new file mode 100644
index 0000000..8146a44
--- /dev/null
+++ b/doc/src/manual/cowboy_sub_protocol.asciidoc
@@ -0,0 +1,27 @@
+= cowboy_sub_protocol(3)
+
+== Name
+
+cowboy_sub_protocol - sub protocol
+
+== Description
+
+The `cowboy_sub_protocol` behaviour defines the interface used
+by modules that implement a protocol on top of HTTP.
+
+== Callbacks
+
+=== upgrade(Req, Env, Handler, HandlerOpts) -> {ok, Req, Env} | {suspend, Module, Function, Args} | {stop, Req}
+
+Req = cowboy_req:req():: The Req object.
+Env = env():: The request environment.
+Handler = module():: Handler module.
+Opts = any():: Handler options.
+Module = module():: MFA to call when resuming the process.
+Function = atom():: MFA to call when resuming the process.
+Args = [any()]:: MFA to call when resuming the process.
+
+Upgrade the protocol.
+
+Please refer to the `cowboy_middleware` manual for a
+description of the return values.
-- 
cgit v1.2.3