make edoc fails

[benoitc]

make edoc with the following error:

[epocxy] make edoc                                                                                                                                                    16:46:59  ☁  master ☀
 GEN    distclean-edoc
 GEN    edoc
./src/cxy_cache.erl, function reserve/2: at line 113: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 110: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 109: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 108: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 106: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 105: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 103: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 100: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 99: multiple @spec tag.
./src/cxy_cache.erl, function reserve/2: at line 98: multiple @spec tag.
edoc: skipping source file './src/cxy_cache.erl': {'EXIT',error}.
./src/cxy_cache_fsm.erl, function start_link/2: at line 51: multiple @spec tag.
./src/cxy_cache_fsm.erl, function start_link/2: at line 49: multiple @spec tag.
./src/cxy_cache_fsm.erl, function start_link/2: at line 48: multiple @spec tag.
edoc: skipping source file './src/cxy_cache_fsm.erl': {'EXIT',error}.
./src/cxy_cache_sup.erl, function start_link/0: at line 39: multiple @spec tag.
./src/cxy_cache_sup.erl, function start_link/0: at line 38: multiple @spec tag.
./src/cxy_cache_sup.erl, function start_link/0: at line 37: multiple @spec tag.
edoc: skipping source file './src/cxy_cache_sup.erl': {'EXIT',error}.
./src/cxy_ctl.erl, function update_spawn_times/5: at line 168: multiple @spec tag.
edoc: skipping source file './src/cxy_ctl.erl': {'EXIT',error}.
./src/cxy_fount.erl, function start_link/4: at line 178: multiple @spec tag.
edoc: skipping source file './src/cxy_fount.erl': {'EXIT',error}.
./src/cxy_fount_sup.erl, function start_link/2: at line 33: multiple @spec tag.
./src/cxy_fount_sup.erl, function start_link/2: at line 32: multiple @spec tag.
edoc: skipping source file './src/cxy_fount_sup.erl': {'EXIT',error}.
./src/cxy_regulator.erl, function start_link/0: at line 65: multiple @spec tag.
edoc: skipping source file './src/cxy_regulator.erl': {'EXIT',error}.
./src/cxy_synch.erl, function before_task/2: at line 41: multiple @spec tag.
edoc: skipping source file './src/cxy_synch.erl': {'EXIT',error}.
./src/ets_buffer.erl, function buffer_type/1: at line 123: multiple @spec tag.
edoc: skipping source file './src/ets_buffer.erl': {'EXIT',error}.
edoc: error in doclet 'edoc_doclet': {'EXIT',error}.
{"init terminating in do_boot",error}

Crash dump is being written to: erl_crash.dump...done
init terminating in do_boot (error)
make: *** [edoc] Error 1

[jaynel]

Yeah, I don't support edoc, I should rip all of that out of the code. I use multiple -spec lines together in one section because I find that easier to understand a module. Using edoc requires all spec to immediately precede the function definition.

I need to write a real user manual for documentation. I'll leave this open to associate with the documentation writing task. I think xdoc (for all languages) provides a quick and dirty, misleading, set of documentation, and the inline nature distracts from reading code. I think documentation should really be geared separately from the code.

I'm thinking that it will be v2.0 before this could be considered a well-documented library, but I'll get there gradually.