search

jlouis / enacl

Erlang bindings for NaCl / libsodium
MIT License
197 stars 59 forks source link

edoc not working #25

Closed romanr321 closed 6 years ago

romanr321 commented 6 years ago

Hi, I can't create documentation using rebar3 edoc. Tried on two machines, which have a working vsn of Rebar3 and edoc works on other projects. ===> Verifying dependencies... ===> Compiling enacl make: Entering directory '/home/rrabinovich/prj/eNaCl/enacl/c_src' make: '/home/rrabinovich/prj/eNaCl/enacl/c_src/../priv/enacl_nif.so' is up to date. make: Leaving directory '/home/rrabinovich/prj/eNaCl/enacl/c_src' ===> Running edoc for enacl edoc: skipping source file '/home/rrabinovich/prj/eNaCl/enacl/src/enacl.erl': {'EXIT', {{badmatch, {atom, 287, '?CRYPTO_GENERICHASH_BYTES_MIN'}}, [{edoc_specs, d2e, 2, [{file, "edoc_specs.erl"}, {line, 347}]}, {edoc_specs, type, 2, [{file, "edoc_specs.erl"}, {line, 67}]}, {edoc_extract, '-get_tags/6-lc$^0/1-0-', 2, [{file, [...]}, {line,...}]}, {edoc_extract, get_tags, 6, [{file,...}, {...}]}, {edoc_extract, get_tags, 6, [{...}|...]}, {edoc_extract, source1, 5, [...]}, {edoc_doclet, source, 9,...}, {lists, foldl,...}]}}. edoc: error in doclet 'edoc_doclet': {'EXIT',error}. ===> Failed to generate documentation for app 'enacl'

jlouis commented 6 years ago

Yep, this is wrong. Closed by 8b8ceff4ef3795f4974, though I didn't look into if the text makes sense.

mike-french commented 5 years ago

I see this error in a different library. I assume the real bug is that edoc does not correctly expand macros in integer range type assignments, and the workaround is to explicitly replace any macro in the from..to values with the integer literal.

(Then I am not sure why you used 10 instead of the defined min value of 16, but that's a separate question :)