Permalink
Browse files

Merge remote branch 'origin/bwf-doc'

  • Loading branch information...
2 parents 216d3e0 + 22e2d5b commit 9c393672fd5d40c5ec5c32c20e5e24917daf0ce3 Bryan Fink committed Aug 23, 2012
Showing with 5 additions and 4 deletions.
  1. +5 −4 src/webmachine_dispatcher.erl
@@ -26,15 +26,16 @@
-define(SEPARATOR, $\/).
-define(MATCH_ALL, '*').
-%% @spec dispatch(Path::string(), DispatchList::[matchterm()]) ->
+%% @spec dispatch(Path::string(), DispatchList::[matchterm()],
+%% wrq:reqdata()) ->
%% dispterm() | dispfail()
%% @doc Interface for URL dispatching.
%% See also http://bitbucket.org/justin/webmachine/wiki/DispatchConfiguration
dispatch(PathAsString, DispatchList, RD) ->
dispatch([], PathAsString, DispatchList, RD).
%% @spec dispatch(Host::string(), Path::string(),
-%% DispatchList::[matchterm()]) ->
+%% DispatchList::[matchterm()], wrq:reqdata()) ->
%% dispterm() | dispfail()
%% @doc Interface for URL dispatching.
%% See also http://bitbucket.org/justin/webmachine/wiki/DispatchConfiguration
@@ -110,8 +111,8 @@ default_port(https) -> 443.
% Any atom pathterm other than '*' will match any token and will
% create a binding in the result if a complete match occurs.
-%% @type guardfun() = function(wrq:reqdata()) -> boolean()
-%% | {Mod::atom(), Fun::atom()}
+%% @type guardfun() = (wrq:reqdata()) -> boolean()
+%% | {Mod::atom(), Fun::atom()}.
% This function or tuple representing a function, if present, is
% called after a successful match of the host, port, and path for a
% dispatch entry. The function should take a single argument, the

0 comments on commit 9c39367

Please sign in to comment.