erlang - 如何控制edoc文件中的函数顺序？

Question

我想为一个 erlang 模块生成 edoc 文件，这是我的代码 http://ideone.com/TFktht ,

我想要导出api接口(interface)，但是我不能成功。

generate_log_statistics/4   Analyse the log files and draw graph.
prepare_sipp_cmd/3  Shows SIPp online help documentation of what config parameters there are.
prepare_systeminfo_filenames/1  Prepare the log files according which blades you want to monitor.
run_scenario/6  Run the SIPp scenario.
start_collect_system_infos/1    Start collecting the logs.
stop_collect_system_infos/1 Stop collecting the logs.

edoc 中这些导出的 api 是没有顺序的。我要:

prepare_sipp_cmd/3
prepare_systeminfo_filenames/1
start_collect_system_infos/1 
run_scenario/6
start_collect_system_infos/1 
generate_log_statistics/4

Answer 1

订购函数

将其放入您的 rebar.config 中:

{edoc_opts, [{sort_functions, true}]}.

或者您可以生成单个文档文件，例如:

edoc:file("src/foo.erl", [{dir, "doc"}, {sort_functions, true}]).

“doc”是输出目录。

实现特定顺序

如上所述关闭函数排序，但使用 {sort_functions, false} 并根据需要对源代码中的函数进行排序。