78 - Documentation : First batch of modules

.gitignore

@@ -25,5 +25,6 @@ rebar3.crashdump
 .rebar3/
 core_vnode_eqc.log
 .idea
+.vscode/
 *.iml
 **/*.coverdata

src/chash.erl

@@ -36,6 +36,7 @@
 
 -module(chash).
 
+
 -export([contains_name/2, fresh/2, lookup/2, key_of/1,
          members/1, merge_rings/2, next_index/2, nodes/1,
          predecessors/2, predecessors/3, ring_increment/1,

src/chashbin.erl

@@ -23,6 +23,7 @@
 %% -------------------------------------------------------------------
 -module(chashbin).
 
+
 -export([create/1, to_chash/1, to_list/1,
          to_list_filter/2, responsible_index/2,
          responsible_position/2, index_owner/2,
@@ -164,6 +165,16 @@ iterator(HashKey, CHBin) ->
     Pos = responsible_position(HashKey, CHBin),
     #iterator{pos = Pos, start = Pos, chbin = CHBin}.
 
+%% @doc Return iterator pointing to the given index
+-spec exact_iterator(Index :: index() | <<_:160>>,
+                     CHBin :: chashbin()) -> iterator().
+
+exact_iterator(<<Idx:160/integer>>, CHBin) ->
+    exact_iterator(Idx, CHBin);
+exact_iterator(Idx, CHBin) ->
+    Pos = index_position(Idx, CHBin),
+    #iterator{pos = Pos, start = Pos, chbin = CHBin}.
+
 %% @doc Return the `{Index, Owner}' pair pointed to by the iterator
 -spec itr_value(iterator()) -> {index(), node()}.
 
@@ -231,7 +242,8 @@ itr_next_while(Pred, Itr) ->
 %% Internal functions
 %% ===================================================================
 
-%% Convert list of {Index, Owner} pairs into `chashbin' binary representation
+%% @private
+%% @doc Convert list of {Index, Owner} pairs into `chashbin' binary representation
 -spec create_bin([{index(), node()}],
                  [{node(), pos_integer()}], binary()) -> owners_bin().
 
@@ -241,15 +253,12 @@ create_bin([{Idx, Owner} | Owners], Nodes, Bin) ->
     Bin2 = <<Bin/binary, Idx:160/integer, Id:16/integer>>,
     create_bin(Owners, Nodes, Bin2).
 
-%% Convert ring index into ring position
+%% @private
+%% @doc Convert ring index into ring position
+-spec index_position(Index :: index() | <<_:160>>,
+                     CHBin :: chashbin()) -> integer().
+
 index_position(<<Idx:160/integer>>, CHBin) ->
     index_position(Idx, CHBin);
 index_position(Idx, #chashbin{size = Size}) ->
     Inc = chash:ring_increment(Size), Idx div Inc rem Size.
-
-%% Return iterator pointing to the given index
-exact_iterator(<<Idx:160/integer>>, CHBin) ->
-    exact_iterator(Idx, CHBin);
-exact_iterator(Idx, CHBin) ->
-    Pos = index_position(Idx, CHBin),
-    #iterator{pos = Pos, start = Pos, chbin = CHBin}.

src/gen_nb_server.erl

@@ -90,13 +90,12 @@
                                              {stop, Reason :: term(),
                                               NewState :: term()}.
 
-%% @spec start_link(Module, IpAddr, Port, InitParams) -> Result
-%% Module = atom()
-%% IpAddr = string()
-%% Port = integer()
-%% InitParams = [any()]
-%% Result = {ok, pid()} | {error, any()}
-%% @doc Start server listening on IpAddr:Port
+%% @doc Start server listening on `IpAddr:Port'.
+-spec start_link(Module :: atom(), IpAddr :: string(),
+                 Port :: integer(), INitParams :: [any()]) -> {ok,
+                                                               pid()} |
+                                                              {error, any()}.
+
 start_link(Module, IpAddr, Port, InitParams) ->
     gen_server:start_link(?MODULE,
                           [Module, IpAddr, Port, InitParams], []).