Просмотр исходного кода

Add a note about crypto websocket usage in the doc comments

Loïc Hoguin 13 лет назад
Родитель
Сommit
14b45fd8a9
1 измененных файлов с 3 добавлено и 21 удалено
  1. 3 21
      src/cowboy_http_websocket.erl

+ 3 - 21
src/cowboy_http_websocket.erl

@@ -14,27 +14,9 @@
 
 
 %% @doc WebSocket protocol implementation.
 %% @doc WebSocket protocol implementation.
 %%
 %%
-%% Supports the protocol version 0 (hixie-76), version 7 (hybi-7)
-%% and version 8 (hybi-8, hybi-9 and hybi-10).
-%%
-%% Version 0 is supported by the following browsers:
-%% <ul>
-%%  <li>Firefox 4-5 (disabled by default)</li>
-%%  <li>Chrome 6-13</li>
-%%  <li>Safari 5.0.1+</li>
-%%  <li>Opera 11.00+ (disabled by default)</li>
-%% </ul>
-%%
-%% Version 7 is supported by the following browser:
-%% <ul>
-%%  <li>Firefox 6</li>
-%% </ul>
-%%
-%% Version 8+ is supported by the following browsers:
-%% <ul>
-%%  <li>Firefox 7+</li>
-%%  <li>Chrome 14+</li>
-%% </ul>
+%% When using websockets, make sure that the crypto application is
+%% included in your release. If you are not using releases then there
+%% is no need for concern as crypto is already included.
 -module(cowboy_http_websocket).
 -module(cowboy_http_websocket).
 
 
 -export([upgrade/4]). %% API.
 -export([upgrade/4]). %% API.