@@ -4,3 +4,6 @@ erl_crash.dump
## Erlware-specific build files
_build
+
+## EDoc
+doc/*
.gitignore
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak basic authentication middleware. This middleware should be
%% avoided unless you need to support older HTTP 1.0 clients over SSL. Digest
@@ -20,7 +20,7 @@
-include("smak.hrl").
-%% @spec init(ewgi_app(), Realm::string(), Auth::function()) -> ewgi_app().
+%% @spec init(ewgi_app(), Realm::string(), Auth::function()) -> ewgi_app()
%% @doc Initializes basic authentication middleware.
-spec init(ewgi_app(), string(), function()) -> ewgi_app().
init(Application, Realm, AuthFunc) when ?IS_EWGI_APPLICATION(Application),
src/smak_auth_basic.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak cookie-based session/authentication middleware.
%% @end
src/smak_auth_cookie.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak digest authentication middleware.
%%
src/smak_auth_digest.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak date/time methods.
%% @end
src/smak_calendar.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Tools for manipulating hexadecimal string representations of binary
%% data.
src/smak_hex.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak HTML utility methods.
%% @end
src/smak_html_util.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak HTTP status methods. A middleware application is provided which
%% catches exceptions of a special form and displays the appropriate status
src/smak_http_status.erl
@@ -14,7 +14,7 @@
-include("smak.hrl").
-%% @spec foldl(Ctx::ewgi_context(), L::[ewgi_app()]) -> ewgi_context().
+%% @spec foldl(Ctx::ewgi_context(), L::[ewgi_app()]) -> ewgi_context()
%% @doc Fold over middleware components L, processing each one with
%% process/2.
%% @see foldr/2
@@ -22,14 +22,14 @@
foldl(Ctx0, L) when is_record(Ctx0, ewgi_context), is_list(L) ->
lists:foldl(fun process/2, Ctx0, L).
-%% @spec foldr(Ctx::ewgi_context(), L::[ewgi_app()]) -> ewgi_context().
+%% @spec foldr(Ctx::ewgi_context(), L::[ewgi_app()]) -> ewgi_context()
%% @doc Same as foldl/2 but in the opposite direction.
%% @see foldl/2
-spec foldr(#ewgi_context{}, [ewgi_app()]) -> #ewgi_context{}.
foldr(Ctx0, L) when is_record(Ctx0, ewgi_context), is_list(L) ->
lists:foldr(fun process/2, Ctx0, L).
-%% @spec process(F::ewgi_app(), Ctx::ewgi_context()) -> ewgi_context().
+%% @spec process(F::ewgi_app(), Ctx::ewgi_context()) -> ewgi_context()
%% @doc If the context contains no errors, processes a middleware
%% component. If the middleware generates an error, it is optionally
%% logged and an error is returned.
@@ -48,14 +48,14 @@ process(F, Ctx) when is_record(Ctx, ewgi_context), ?IS_EWGI_APPLICATION(F) ->
Ctx
end.
-%% @spec noop() -> ewgi_app().
+%% @spec noop() -> ewgi_app()
%% @doc Simple 'noop' middleware that returns the EWGI context unchanged.
-spec noop() -> ewgi_app().
noop() ->
fun(Ctx) -> Ctx end.
-%% @spec compose(G::ewgi_app(), F::ewgi_app()) -> ewgi_app().
-%% @doc Compose two EWGI applications: G ∘ F
+%% @spec compose(G::ewgi_app(), F::ewgi_app()) -> ewgi_app()
+%% @doc Compose two EWGI applications: G ∘ F
%% Equivalent to: fun(C) -> G(F(C)) end.
-spec compose(ewgi_app(), ewgi_app()) -> ewgi_app().
compose(G, F) ->
src/smak_mw.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak utilities for generating random numbers.
%% @end
src/smak_random.erl
@@ -4,9 +4,9 @@
%% @doc Smak URL routing. We define a mechanism for building URL routes
%% using regular expressions with the possibility of a naive reverse
%% match which produces a URL from a set of matches.
-%%
+%%
%% Examples:
-%%
+%% ```
%% ["users/", {name, "\w+", "foo"}, "/"]
%% gets mapped to a regular expression that looks like:
%% "^users/(?P<name>\w+)/$"
@@ -14,6 +14,7 @@
%% ["users/", {name, "\w+"}, "/images"]
%% becomes:
%% "^users/(?P<name>\w+)/images$"
+%% '''
%% @end
%%
%% Licensed under the MIT license:
@@ -113,7 +114,7 @@ look_mod(M) ->
route(Name, Pat) ->
route(Name, <<"">>, Pat).
-%% @spec route(Name::rname(), Doc::binary(), Pattern:pattern()) -> croute()
+%% @spec route(Name::rname(), Doc::binary(), Pattern::pattern()) -> croute()
%% @equiv route(Name, Doc, Pat, [])
-spec route(rname(), binary(), pattern()) -> #croute{}.
route(Name, Doc, Pat) ->
@@ -125,7 +126,7 @@ route(Name, Doc, Pat) ->
%% Pattern. Doc is a documentation string held in the routing
%% structure for introspection. Only group names present in Groups
%% will be returned in the resolve stage.
-%%
+%%
%% A pattern is specified by a list of pattern elements which are
%% matched in order from left to right. Matching is similar to
%% 'greedy' regular expression evaluation (in fact, the current
@@ -133,14 +134,16 @@ route(Name, Doc, Pat) ->
%%
%% A route pattern consists of a literal or a match group:
%% <dl>
-%% <dt>Literal</dt>
-%% <dd>A literal is simply a PCRE regular expression which must match
-%% the URI</dd>
-%% <dt>Match Group</dt>
-%% <dd>A match group is a 2 or 3-tuple of the form {Name, Expression}
-%% or {Name, Expression, Default} where Name is a string and
-%% Expression is a string representing a PCRE regular expression. The
-%% Default value is used if the expression segment doesn't match.</dd>
+%% <dt>Literal</dt>
+%% <dd>A literal is simply a PCRE regular expression which must
+%% match the URI</dd>
+%% <dt>Match Group</dt>
+%% <dd>A match group is a 2 or 3-tuple of the form {Name,
+%% Expression} or {Name, Expression, Default} where Name is a
+%% string and Expression is a string representing a PCRE regular
+%% expression. The Default value is used if the expression
+%% segment doesn't match.</dd>
+%% </dl>
%%
%% Patterns concatenate the expressions to create a full URI regular
%% expression.
@@ -174,7 +177,7 @@ rename(L) when is_list(L) ->
%% @spec resolve(Routes::gb_tree(), Url::string()) -> mresult()
%%
-%% @type mresult() :: 'nomatch' | {rname(), pmatches()}
+%% @type mresult() = 'nomatch' | {rname(), pmatches()}
%% @doc Resolve a particular URL using the routing tree. Simply
%% returns the match result for dispatching.
-type mresult() :: 'nomatch' | {rname(), pmatches()}.
src/smak_route.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Implementation of compressed, signed, encrypted share-nothing
%% cookie-based sessions.
src/smak_sn_cookie.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%% @doc Smak "streams" implementation for compatibility with EWGI. It makes
%% extensive use of the DELAY and FORCE macros to make the code slightly more
src/smak_streams.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak miscellaneous string functions
%% @end
src/smak_string.erl
@@ -1,5 +1,5 @@
%% @author Hunter Morris <hunter.morris@smarkets.com>
-%% @copyright 2008 Smarkets Limited.
+%% @copyright 2009 Smarkets Limited.
%%
%% @doc Smak URL handling methods.
%% @end
src/smak_url.erl
12c927e42db0dfe9f3f5a09235e7f735e37031c4
Hunter Morris
huntermorris@gmail.com
http://github.com/skarab/smak/commit/db56c57773a00c3b0e3f41bf0d8ac82c120ff81c
db56c57773a00c3b0e3f41bf0d8ac82c120ff81c
2009-03-11T11:21:37-07:00
2009-03-11T11:21:37-07:00
Fixed EDoc errors
Updated copyright year
57c234fe0b735cd877cf785875bfd567fb951e65
Hunter Morris
huntermorris@gmail.com