From 973e67a53ce73ef71073715f1bced5bd6be6c9a1 Mon Sep 17 00:00:00 2001
From: Magnus Klaar <magnus.klaar@gmail.com>
Date: Thu, 29 Sep 2011 16:53:47 +0200
Subject: add note to split_path/1 and path/1 on escaped /

---
 src/cowboy_dispatcher.erl | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'src/cowboy_dispatcher.erl')

diff --git a/src/cowboy_dispatcher.erl b/src/cowboy_dispatcher.erl
index c402e01..3594767 100644
--- a/src/cowboy_dispatcher.erl
+++ b/src/cowboy_dispatcher.erl
@@ -45,7 +45,11 @@ split_host(Host) ->
 				list_to_integer(binary_to_list(Port))}
 	end.
 
-%% @doc Split a path into a list of tokens.
+%% @doc Split a path into a list of path segments.
+%%
+%% Follwing RFC2396, this function may return path segments containing any
+%% character, including <em>/</em> if, and only if, a <em>/</em> was escaped
+%% and part of a path segment.
 -spec split_path(binary()) -> {path_tokens(), binary(), binary()}.
 split_path(Path) ->
 	case binary:split(Path, <<"?">>) of
-- 
cgit v1.2.3