aboutsummaryrefslogtreecommitdiffstats
path: root/src/cowboy_req.erl
diff options
context:
space:
mode:
authorpmyarchon <[email protected]>2013-07-18 12:16:03 +0400
committerpmyarchon <[email protected]>2013-07-18 12:16:03 +0400
commit95c915dfaa7bb1d5b0da8f532d300c6c7bd86629 (patch)
treeeb1e49c17b3a84ec935619942f49e7e0d4d2c5ff /src/cowboy_req.erl
parentddefa33a38e045d1359149f911359343105a0ce0 (diff)
downloadcowboy-95c915dfaa7bb1d5b0da8f532d300c6c7bd86629.tar.gz
cowboy-95c915dfaa7bb1d5b0da8f532d300c6c7bd86629.tar.bz2
cowboy-95c915dfaa7bb1d5b0da8f532d300c6c7bd86629.zip
Slight docs fix in cowboy_req.erl
Diffstat (limited to 'src/cowboy_req.erl')
-rw-r--r--src/cowboy_req.erl8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/cowboy_req.erl b/src/cowboy_req.erl
index 5ebcf99..66abcf8 100644
--- a/src/cowboy_req.erl
+++ b/src/cowboy_req.erl
@@ -791,9 +791,9 @@ body_qs(MaxBodyLength, Req) ->
%% @doc Return data from the multipart parser.
%%
%% Use this function for multipart streaming. For each part in the request,
-%% this function returns <em>{headers, Headers}</em> followed by a sequence of
-%% <em>{body, Data}</em> tuples and finally <em>end_of_part</em>. When there
-%% is no part to parse anymore, <em>eof</em> is returned.
+%% this function returns <em>{headers, Headers, Req}</em> followed by a sequence of
+%% <em>{body, Data, Req}</em> tuples and finally <em>{end_of_part, Req}</em>. When there
+%% is no part to parse anymore, <em>{eof, Req}</em> is returned.
-spec multipart_data(Req)
-> {headers, cowboy:http_headers(), Req} | {body, binary(), Req}
| {end_of_part | eof, Req} when Req::req().
@@ -832,7 +832,7 @@ multipart_data(Req, Length, {more, Parser}) when Length > 0 ->
%% @doc Skip a part returned by the multipart parser.
%%
%% This function repeatedly calls <em>multipart_data/1</em> until
-%% <em>end_of_part</em> or <em>eof</em> is parsed.
+%% <em>{end_of_part, Req}</em> or <em>{eof, Req}</em> is parsed.
-spec multipart_skip(Req) -> {ok, Req} when Req::req().
multipart_skip(Req) ->
case multipart_data(Req) of