From b2bd9ccfb582213909129b6a54514b968856168a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Mon, 2 Oct 2017 18:06:06 +0200
Subject: Document cow_ws:frame in Cowboy for now

---
 doc/src/manual/cowboy_websocket.asciidoc | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

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

diff --git a/doc/src/manual/cowboy_websocket.asciidoc b/doc/src/manual/cowboy_websocket.asciidoc
index 2421ae8..40864c5 100644
--- a/doc/src/manual/cowboy_websocket.asciidoc
+++ b/doc/src/manual/cowboy_websocket.asciidoc
@@ -32,7 +32,7 @@ PartialReq :: map()
 State      :: any()
 Opts       :: cowboy_websocket:opts()
 InFrame    :: {text | binary | ping | pong, binary()}
-OutFrame   :: cow_ws:frame()
+OutFrame   :: cow_ws:frame()                    %% see types below
 Info       :: any()
 
 CallResult :: {ok, State}
@@ -128,6 +128,24 @@ timeout::
 
 == Types
 
+==== cow_ws:frame()
+
+[source,erlang]
+----
+frame() :: {text, iodata()}
+    | {binary, iodata()}
+    | ping | {ping, iodata()}
+    | pong | {pong, iodata()}
+    | close | {close, iodata()} | {close, close_code(), iodata()}
+
+close_code() :: 1000..1003 | 1006..1011 | 3000..4999
+----
+
+Websocket frames that can be sent as a response.
+
+Note that there is no need to send pong frames back as
+Cowboy does it automatically for you.
+
 === opts()
 
 [source,erlang]
-- 
cgit v1.2.3

