fix edoc errors in various modules
Signed-off-by: Jordan Wilberding <diginux@gmail.com>
This commit is contained in:
parent
51b5a41c63
commit
d7b60ccf19
6 changed files with 49 additions and 49 deletions
|
@ -4,8 +4,8 @@
|
|||
%%% @doc
|
||||
%%% provides an implementation of ec_dictionary using an association
|
||||
%%% list as a basy
|
||||
%%% see ec_dictionary
|
||||
%%% @end
|
||||
%%% @see ec_dictionary
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(ec_assoc_list).
|
||||
|
||||
|
|
|
@ -5,9 +5,9 @@
|
|||
%%% This provides an implementation of the ec_dictionary type using
|
||||
%%% erlang dicts as a base. The function documentation for
|
||||
%%% ec_dictionary applies here as well.
|
||||
%%% see ec_dictionary
|
||||
%%% see dict
|
||||
%%% @end
|
||||
%%% @see ec_dictionary
|
||||
%%% @see dict
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(ec_dict).
|
||||
|
||||
|
|
|
@ -83,7 +83,7 @@ has_key(Key, #dict_t{callback = Mod, data = Data}) ->
|
|||
%%
|
||||
%% @param Dict The dictionary object to return the value from
|
||||
%% @param Key The key requested
|
||||
%% @throws not_found when the key does not exist
|
||||
%% when the key does not exist @throws not_found
|
||||
-spec get(key(K), dictionary(K, V)) -> value(V).
|
||||
get(Key, #dict_t{callback = Mod, data = Data}) ->
|
||||
Mod:get(Key, Data).
|
||||
|
|
|
@ -4,9 +4,9 @@
|
|||
%%% @doc
|
||||
%%% This provides an implementation of the type ec_dictionary using
|
||||
%%% gb_trees as a backin
|
||||
%%% see ec_dictionary
|
||||
%%% see gb_trees
|
||||
%%% @end
|
||||
%%% @see ec_dictionary
|
||||
%%% @see gb_trees
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(ec_gb_trees).
|
||||
|
||||
|
@ -68,7 +68,7 @@ has_key(Key, Data) ->
|
|||
%%
|
||||
%% @param Object The dictionary object to return the value from
|
||||
%% @param Key The key requested
|
||||
%% @throws not_found when the key does not exist
|
||||
%% when the key does not exist @throws not_found
|
||||
-spec get(ec_dictionary:key(K), Object::dictionary(K, V)) ->
|
||||
ec_dictionary:value(V).
|
||||
get(Key, Data) ->
|
||||
|
|
|
@ -5,9 +5,9 @@
|
|||
%%% This provides an implementation of the ec_dictionary type using
|
||||
%%% erlang orddicts as a base. The function documentation for
|
||||
%%% ec_dictionary applies here as well.
|
||||
%%% see ec_dictionary
|
||||
%%% see orddict
|
||||
%%% @end
|
||||
%%% @see ec_dictionary
|
||||
%%% @see orddict
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(ec_orddict).
|
||||
|
||||
|
|
|
@ -51,8 +51,8 @@
|
|||
%%% l/rbalance, the colour, in store etc. is actually slower than not
|
||||
%%% doing it. Measured.
|
||||
%%%
|
||||
%%% see ec_dictionary
|
||||
%%% @end
|
||||
%%% @see ec_dictionary
|
||||
%%%-------------------------------------------------------------------
|
||||
-module(ec_rbdict).
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue