diff options
| author | Fred Hebert <mononcqc@ferd.ca> | 2016-11-25 21:32:43 -0500 |
|---|---|---|
| committer | Fred Hebert <mononcqc@ferd.ca> | 2016-11-27 20:59:56 -0500 |
| commit | 3da4cc222197e01886d3baaeca7a380e02ff3125 (patch) | |
| tree | d49eefc436143cb9dc4f401257f55e0e8e61b30e /src/rebar_file_utils.erl | |
| parent | 252634d31e51d8896f0e17e1af5e91de964dd555 (diff) | |
Type specifications and edocs improvements
Includes improvments and function documentation for all modules (in
alphabetical order) up to rebar_core, and may have included more in
other modules as I saw fit to dig and understand more of the internals.
Diffstat (limited to 'src/rebar_file_utils.erl')
| -rw-r--r-- | src/rebar_file_utils.erl | 6 |
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)}. |