Merge pull request #1391 from ferd/doc-and-types

Type specifications and edocs improvements

1 files changed, 2 insertions, 4 deletions

diff --git a/src/rebar_file_utils.erl b/src/rebar_file_utils.erl
index f2467c5..8645641 100644
--- a/src/rebar_file_utils.erl
+++ b/src/rebar_file_utils.erl
@@ -300,9 +300,8 @@ canonical_path([_|Acc], [".."|Rest])  -> canonical_path(Acc, Rest);
 canonical_path([], [".."|Rest])       -> canonical_path([], Rest);
 canonical_path(Acc, [Component|Rest]) -> canonical_path([Component|Acc], Rest).
 
-%% returns canonical target of path if path is a link, otherwise returns path
+%% @doc returns canonical target of path if path is a link, otherwise returns path
 -spec resolve_link(string()) -> string().
-
 resolve_link(Path) ->
     case file:read_link(Path) of
         {ok, Target} ->
@@ -310,9 +309,8 @@ resolve_link(Path) ->
         {error, _} -> Path
     end.
 
-%% splits a path into dirname and basename
+%% @doc splits a path into dirname and basename
 -spec split_dirname(string()) -> {string(), string()}.
-
 split_dirname(Path) ->
     {filename:dirname(Path), filename:basename(Path)}.