Makefile

@@ -35,6 +35,9 @@ deps:
 clean:
 	$(REBAR) -r clean
 
+edoc: edoc-clean
+	$(REBAR) skip_deps=true doc
+
 edoc-clean:
 	rm -f edoc/*.png edoc/*.html edoc/*.css edoc/edoc-info
 

src/machi_csum_table.erl

@@ -332,7 +332,7 @@ runthru(_L, _O, _P) ->
     false.
 
 %% @doc If you want to find an overlap among two areas [x, y] and [a,
-%% b] where x < y and a < b; if (a-y)*(b-x) < 0 then there's a
+%% b] where x &lt; y and a &lt; b; if (a-y)*(b-x) &lt; 0 then there's a
 %% overlap, else, > 0 then there're no overlap. border condition = 0
 %% is not overlap in this offset-size case.
 inclusion_match_spec(Offset, Size) ->

src/machi_dt.erl

@@ -44,7 +44,7 @@
 -type projection()      :: #projection_v1{}.
 -type projection_type() :: 'public' | 'private'.
 
-%% @doc Tags that stand for how that checksum was generated. See
+%% Tags that stand for how that checksum was generated. See
 %% machi_util:make_tagged_csum/{1,2} for further documentation and
 %% implementation.
 -type csum_tag()    :: none | client_sha | server_sha | server_regen_sha.

src/machi_flu_sup.erl

@@ -21,7 +21,7 @@
 %% @doc Supervisor for Machi FLU servers and their related support
 %% servers.
 %%
-%% Responsibility for managing FLU & chain lifecycle after the initial
+%% Responsibility for managing FLU and chain lifecycle after the initial
 %% application startup is delegated to {@link machi_lifecycle_mgr}.
 %%
 %% See {@link machi_flu_psup} for an illustration of the entire Machi

src/machi_lifecycle_mgr.erl

@@ -101,7 +101,7 @@
 %% used to permanently delete such FLUs' data files, i.e. to reclaim
 %% disk space.
 %%
-%% Resources for the FLU are defined in {@link machi_projection.hrl}
+%% Resources for the FLU are defined in `machi_projection.hrl'
 %% in the `p_srvr{}' record.  The major elements of this record are:
 %%
 %% <ul>
@@ -147,7 +147,7 @@
 %% created.  External policy is responsible for creating each of these
 %% files.
 %%
-%% Resources for the chain are defined in {@link machi_projection.hrl}
+%% Resources for the chain are defined in `machi_projection.hrl'
 %% in the `chain_def_v1{}' record.  The major elements of this record are:
 %%
 %% <ul>
@@ -174,7 +174,7 @@
 %% </li>
 %% </ul>
 %%
-%% == Conflicts with TCP ports, FLU & chain names, etc ==
+%% == Conflicts with TCP ports, FLU &amp; chain names, etc ==
 %%
 %% This manager is not responsible for managing conflicts in resource
 %% namespaces, e.g., TCP port numbers, FLU names, chain names, etc.

src/machi_pb_high_client.erl

@@ -58,7 +58,7 @@
           count=0     :: non_neg_integer()
          }).
 
-%% @doc official error types that is specific in Machi
+%% Official error types that is specific in Machi
 -type machi_client_error_reason() :: bad_arg | wedged | bad_checksum |
                                      partition | not_written | written |
                                      trimmed | no_such_file | partial_read |
@@ -145,7 +145,7 @@ read_chunk(PidSpec, File, Offset, Size, Options, Timeout) ->
     send_sync(PidSpec, {read_chunk, File, Offset, Size, Options}, Timeout).
 
 %% @doc Trims arbitrary binary range of any file. If a specified range
-%% has any byte trimmed, it fails and returns `{error, trimmed}`.
+%% has any byte trimmed, it fails and returns `{error, trimmed}'.
 %% Otherwise it trims all bytes in that range. If there are
 %% overlapping chunks with client-specified checksum, they will cut
 %% off and checksum are re-calculated in server side.  TODO: Add