fix edoc errors in various modules

Signed-off-by: Jordan Wilberding <diginux@gmail.com>

src/ec_assoc_list.erl

@@ -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).
 

src/ec_dict.erl

@@ -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).
 

src/ec_dictionary.erl

@@ -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).

src/ec_gb_trees.erl

@@ -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).
 
@@ -14,16 +14,16 @@
 
 %% API
 -export([new/0,
-	 has_key/2,
+         has_key/2,
-	 get/2,
+         get/2,
-	 get/3,
+         get/3,
-	 add/3,
+         add/3,
-	 remove/2,
+         remove/2,
-	 has_value/2,
+         has_value/2,
-	 size/1,
+         size/1,
-	 to_list/1,
+         to_list/1,
-	 from_list/1,
+         from_list/1,
-	 keys/1]).
+         keys/1]).
 
 -export_type([dictionary/2]).
 
@@ -33,8 +33,8 @@
 -opaque dictionary(K, V) :: {non_neg_integer(), ec_gb_tree_node(K, V)}.
 
 -type ec_gb_tree_node(K, V) :: 'nil' | {K, V,
-					ec_gb_tree_node(K, V),
+                                        ec_gb_tree_node(K, V),
-					ec_gb_tree_node(K, V)}.
+                                        ec_gb_tree_node(K, V)}.
 
 %%%===================================================================
 %%% API
@@ -57,10 +57,10 @@ new() ->
 -spec has_key(ec_dictionary:key(K), Object::dictionary(K, _V)) -> boolean().
 has_key(Key, Data) ->
     case gb_trees:lookup(Key, Data) of
-	{value, _Val} ->
+        {value, _Val} ->
-	    true;
+            true;
-	none ->
+        none ->
-	    false
+            false
     end.
 
 %% @doc given a key return that key from the dictionary. If the key is
@@ -68,27 +68,27 @@ 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) ->
     case gb_trees:lookup(Key, Data) of
-	{value, Value} ->
+        {value, Value} ->
-	    Value;
+            Value;
-	none ->
+        none ->
-	    throw(not_found)
+            throw(not_found)
     end.
 
 -spec get(ec_dictionary:key(K),
-	  ec_dictionary:value(V),
+          ec_dictionary:value(V),
-	  Object::dictionary(K, V)) ->
+          Object::dictionary(K, V)) ->
     ec_dictionary:value(V).
 get(Key, Default, Data) ->
     case gb_trees:lookup(Key, Data) of
-	{value, Value} ->
+        {value, Value} ->
-	    Value;
+            Value;
-	none ->
+        none ->
-	    Default
+            Default
     end.
 
 %% @doc add a new value to the existing dictionary. Return a new
@@ -98,7 +98,7 @@ get(Key, Default, Data) ->
 %% @param Key the key to add
 %% @param Value the value to add
 -spec add(ec_dictionary:key(K), ec_dictionary:value(V),
-	  Object::dictionary(K, V)) ->
+          Object::dictionary(K, V)) ->
     dictionary(K, V).
 add(Key, Value, Data) ->
     gb_trees:enter(Key, Value, Data).
@@ -129,7 +129,7 @@ size(Data) ->
     gb_trees:size(Data).
 
 -spec to_list(dictionary(K, V)) -> [{ec_dictionary:key(K),
-				     ec_dictionary:value(V)}].
+                                     ec_dictionary:value(V)}].
 to_list(Data) ->
     gb_trees:to_list(Data).
 
@@ -137,10 +137,10 @@ to_list(Data) ->
     dictionary(K, V).
 from_list(List) when is_list(List) ->
     lists:foldl(fun({Key, Value}, Dict) ->
-			gb_trees:enter(Key, Value, Dict)
+                        gb_trees:enter(Key, Value, Dict)
-		end,
+                end,
-		gb_trees:empty(),
+                gb_trees:empty(),
-		List).
+                List).
 
 -spec keys(dictionary(K,_V)) -> [ec_dictionary:key(K)].
 keys(Data) ->
@@ -189,12 +189,12 @@ add_test() ->
 
     Dict01 = ec_dictionary:add(Key1, Value1, Dict0),
     Dict02 = ec_dictionary:add(Key3, Value3,
-			       ec_dictionary:add(Key2, Value2,
+                               ec_dictionary:add(Key2, Value2,
-						 Dict01)),
+                                                 Dict01)),
     Dict1 =
-	ec_dictionary:add(Key5, Value5,
+        ec_dictionary:add(Key5, Value5,
-			  ec_dictionary:add(Key4, Value4,
+                          ec_dictionary:add(Key4, Value4,
-					    Dict02)),
+                                            Dict02)),
 
     ?assertMatch(Value1, ec_dictionary:get(Key1, Dict1)),
     ?assertMatch(Value2, ec_dictionary:get(Key2, Dict1)),
@@ -204,7 +204,7 @@ add_test() ->
 
 
     Dict2 = ec_dictionary:add(Key3, Value5,
-			      ec_dictionary:add(Key2, Value4, Dict1)),
+                              ec_dictionary:add(Key2, Value4, Dict1)),
 
 
     ?assertMatch(Value1, ec_dictionary:get(Key1, Dict2)),
@@ -216,7 +216,7 @@ add_test() ->
 
     ?assertThrow(not_found, ec_dictionary:get(should_blow_up, Dict2)),
     ?assertThrow(not_found, ec_dictionary:get("This should blow up too",
-					      Dict2)).
+                                              Dict2)).
 
 
 

src/ec_orddict.erl

@@ -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).
 

src/ec_rbdict.erl

@@ -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).