fix doc

Author: soranoba

Makefile

@@ -22,7 +22,7 @@ eunit:
 	@./rebar3 eunit
 
 edoc:
-	@./rebar3 as dev edoc
+	@./rebar3 as doc edoc
 
 start:
 	@./rebar3 as dev shell

doc/bbmustache.md

@@ -136,7 +136,7 @@ __abstract datatype__: `template()`
 ## Function Index ##
 
 
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#compile-2">compile/2</a></td><td>Equivalent to <a href="#compile-3"><tt>compile(Template, Data, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#compile-3">compile/3</a></td><td>Embed the data in the template.</td></tr><tr><td valign="top"><a href="#default_partial_file_reader-2">default_partial_file_reader/2</a></td><td>Default partial file reader.</td></tr><tr><td valign="top"><a href="#default_value_serializer-1">default_value_serializer/1</a></td><td>Default value serializer for templtated values.</td></tr><tr><td valign="top"><a href="#main-1">main/1</a></td><td>escript entry point.</td></tr><tr><td valign="top"><a href="#parse_binary-1">parse_binary/1</a></td><td>Equivalent to <a href="#parse_binary-2"><tt>parse_binary(Bin, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#parse_binary-2">parse_binary/2</a></td><td>Create a <a href="#template-0"><code>template/0</code></a> from a binary.</td></tr><tr><td valign="top"><a href="#parse_file-1">parse_file/1</a></td><td>Equivalent to <a href="#parse_file-2"><tt>parse_file(Filename, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#parse_file-2">parse_file/2</a></td><td>Create a <a href="#template-0"><code>template/0</code></a> from a file.</td></tr><tr><td valign="top"><a href="#render-2">render/2</a></td><td>Equivalent to <a href="#render-3"><tt>render(Bin, Data, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#render-3">render/3</a></td><td>Equivalent to <a href="#compile-3"><tt>compile(parse_binary(Bin), Data, Options)</tt></a>.</td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#compile-2">compile/2</a></td><td>Equivalent to <a href="#compile-3"><tt>compile(Template, Data, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#compile-3">compile/3</a></td><td>Embed the data in the template.</td></tr><tr><td valign="top"><a href="#default_partial_file_reader-2">default_partial_file_reader/2</a></td><td>Default partial file reader.</td></tr><tr><td valign="top"><a href="#default_value_serializer-1">default_value_serializer/1</a></td><td>Default value serializer for templtated values.</td></tr><tr><td valign="top"><a href="#parse_binary-1">parse_binary/1</a></td><td>Equivalent to <a href="#parse_binary-2"><tt>parse_binary(Bin, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#parse_binary-2">parse_binary/2</a></td><td>Create a <a href="#template-0"><code>template/0</code></a> from a binary.</td></tr><tr><td valign="top"><a href="#parse_file-1">parse_file/1</a></td><td>Equivalent to <a href="#parse_file-2"><tt>parse_file(Filename, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#parse_file-2">parse_file/2</a></td><td>Create a <a href="#template-0"><code>template/0</code></a> from a file.</td></tr><tr><td valign="top"><a href="#render-2">render/2</a></td><td>Equivalent to <a href="#render-3"><tt>render(Bin, Data, [])</tt></a>.</td></tr><tr><td valign="top"><a href="#render-3">render/3</a></td><td>Equivalent to <a href="#compile-3"><tt>compile(parse_binary(Bin), Data, Options)</tt></a>.</td></tr></table>
 
 
 <a name="functions"></a>
@@ -196,17 +196,6 @@ default_value_serializer(Integer::number() | binary() | string() | atom()) -&gt;
 
 Default value serializer for templtated values
 
-<a name="main-1"></a>
-
-### main/1 ###
-
-<pre><code>
-main(Args::string()) -&gt; ok
-</code></pre>
-<br />
-
-escript entry point
-
 <a name="parse_binary-1"></a>
 
 ### parse_binary/1 ###

rebar.config

@@ -45,12 +45,16 @@
             {dev, [{erl_opts, [{d, bbmustache_escriptize}]},
                    {deps,
                     [
-                     {edown, ".*", {git, "git://github.com/uwiger/edown.git", {branch, "master"}}},
                      {getopt, "1.0.1"}
                     ]},
                     {plugins, [rebar3_git_vsn]},
                     {provider_hooks, [{post, [{compile, git_vsn}]}]}
                   ]},
+            {doc, [{deps,
+                    [
+                     {edown, ".*", {git, "git://github.com/uwiger/edown.git", {branch, "master"}}}
+                    ]}
+                  ]},
             {bench, [{deps,
                       [
                        {mustache, ".*", {git, "git://github.com/mojombo/mustache.erl", {tag, "v0.1.1"}}}

src/bbmustache.erl

@@ -700,8 +700,7 @@ is_recursive_data(_)                                -> false.
 
 -ifdef(bbmustache_escriptize).
 
-%% @doc escript entry point
-%% @private
+%% escript entry point
 -spec main([string()]) -> ok.
 main(Args) ->
     %% Load the application to be able to access its information
@@ -716,7 +715,7 @@ main(Args) ->
             halt(1)
     end.
 
-%% @doc Processes command-line commands (render, ...)
+%% Processes command-line commands
 -spec process_commands([getopt:option()], [string()]) -> ok.
 process_commands(Opts, Cmds) ->
     HasHelp = proplists:is_defined(help, Opts),
@@ -728,7 +727,7 @@ process_commands(Opts, Cmds) ->
         true                        -> process_render(Opts, Cmds)
     end.
 
-%% @doc Returns command-line options.
+%% Returns command-line options.
 -spec option_spec_list() -> [getopt:option_spec()].
 option_spec_list() ->
 [
@@ -739,6 +738,7 @@ option_spec_list() ->
     {data_file,         $d,         "data-file",    string,         "Erlang terms file."}
 ].
 
+%% Processes render
 -spec process_render([getopt:option()], [string()]) -> ok.
 process_render(Opts, TemplateFileNames) ->
     DataFileNames = proplists:get_all_values(data_file, Opts),
@@ -754,12 +754,12 @@ process_render(Opts, TemplateFileNames) ->
                       end
                   end, TemplateFileNames).
 
-%% @doc Prints usage/help.
+%% Prints usage/help.
 -spec print_help(getopt:output_stream()) -> ok.
 print_help(OutputStream) ->
     getopt:usage(option_spec_list(), escript:script_name(), "template_files ...", OutputStream).
 
-%% @doc Prints version.
+%% Prints version.
 -spec print_version() -> ok.
 print_version() ->
     Vsn = case application:get_key(bbmustache, vsn) of
@@ -773,7 +773,7 @@ print_version() ->
     %% e.g. bbmustache v1.9.0+build.5.ref90a0afd4f2
     io:format("bbmustache v~s~s~n", [Vsn, AdditionalVsn]).
 
-%% @doc Read the data-file and return terms.
+%% Read the data-file and return terms.
 -spec read_data_files(file:filename_all()) -> [term()].
 read_data_files(Filename) ->
     case file:consult(Filename) of