From 078d686a0ac0aed212db97d73bd1e4a9387a4956 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sun, 6 Jul 2014 13:10:35 +0200 Subject: Provide installable man pages make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/. --- manual/cowboy_websocket.md | 40 ---------------------------------------- 1 file changed, 40 deletions(-) delete mode 100644 manual/cowboy_websocket.md (limited to 'manual/cowboy_websocket.md') diff --git a/manual/cowboy_websocket.md b/manual/cowboy_websocket.md deleted file mode 100644 index 9a81878..0000000 --- a/manual/cowboy_websocket.md +++ /dev/null @@ -1,40 +0,0 @@ -cowboy_websocket -================ - -The `cowboy_websocket` module implements the Websocket protocol. - -The callbacks for websocket handlers are defined in the manual -for the `cowboy_websocket_handler` behaviour. - -Types ------ - -### close_code() = 1000..4999 - -> Reason for closing the connection. - -### frame() = close | ping | pong - | {text | binary | close | ping | pong, iodata()} - | {close, close_code(), iodata()} - -> Frames that can be sent to the client. - -Meta values ------------ - -### websocket_compress - -> Type: true | false -> -> Whether a websocket compression extension in in use. - -### websocket_version - -> Type: 7 | 8 | 13 -> -> The version of the Websocket protocol being used. - -Exports -------- - -None. -- cgit v1.2.3