[erlang-questions] edoc generation

sm <>
Mon Jun 17 13:01:51 CEST 2013


I've just ran edoc on a collection of erlang source files with the 
command: erl -noshell -run edoc_run application 'app' '"src"' '[{dir, 
"src"}]'

The source files contain the erlang library.
A few libraries gave this result:

src/tls_record.erl, function is_acceptable_version/1: at line 477: 
multiple @spec tag.
edoc: skipping source file 'src/tls_record.erl': {'EXIT',error}.
src/orber_ifr_aliasdef.erl: at line 61: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_aliasdef.erl': {'EXIT',error}.
src/orber_ifr_idltype.erl: at line 46: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_idltype.erl': {'EXIT',error}.
src/mnesia_power_SUITE.erl: at line 37: syntax error before: mnesia
edoc: skipping source file 'src/mnesia_power_SUITE.erl': {'EXIT',error}.
src/ssl.erl, function start/0: at line 80: multiple @spec tag.
edoc: skipping source file 'src/ssl.erl': {'EXIT',error}.
src/distr_startup_SUITE.erl: at line 68: syntax error before: Nodes
edoc: skipping source file 'src/distr_startup_SUITE.erl': {'EXIT',error}.
src/orber_ifr_arraydef.erl: at line 53: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_arraydef.erl': {'EXIT',error}.
src/diameter_capx.erl: at line 120: syntax error before: ';'
edoc: skipping source file 'src/diameter_capx.erl': {'EXIT',error}.
src/orber_ifr_interfacedef.erl: at line 85: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_interfacedef.erl': {'EXIT',error}.
src/tls.erl, function start/0: at line 88: multiple @spec tag.
edoc: skipping source file 'src/tls.erl': {'EXIT',error}.
src/orber_ifr_operationdef.erl: at line 72: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_operationdef.erl': {'EXIT',error}.
src/dialyzer_utils.erl, function pp_hook/3: at line 456: @spec arity 
does not match.
edoc: skipping source file 'src/dialyzer_utils.erl': {'EXIT',error}.
2543- fatal: {endtag_does_not_match,{was,code,should_have_been,ocde}}
src/ct_gen_conn.erl, function start/4: at line 61: error in XML parser: 
{fatal,{{endtag_does_not_match, {was,code,should_have_been,ocde}}, 
{file,file_name_unknown}, {line,86},{col,61}}}.
edoc: skipping source file 'src/ct_gen_conn.erl': {'EXIT',error}.
src/ct_framework.erl, function add_data_dir/2: at line 1331: @spec arity 
does not match.
edoc: skipping source file 'src/ct_framework.erl': {'EXIT',error}.
src/orber_ifr_constantdef.erl: at line 65: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_constantdef.erl': {'EXIT',error}.
src/orber_ifr_fixeddef.erl: at line 48: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_fixeddef.erl': {'EXIT',error}.
src/public_key.erl, function pem_entry_decode/1: at line 86: @spec arity 
does not match.
edoc: skipping source file 'src/public_key.erl': {'EXIT',error}.
src/orber_ifr_exceptiondef.erl: at line 64: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_exceptiondef.erl': {'EXIT',error}.
src/diameter_dbg.erl: at line 116: syntax error before: '.'
edoc: skipping source file 'src/diameter_dbg.erl': {'EXIT',error}.
src/orber_ifr_repository.erl: at line 65: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_repository.erl': {'EXIT',error}.
src/zip.erl: at line 216: syntax error before: do_openzip_open
edoc: skipping source file 'src/zip.erl': {'EXIT',error}.
src/ct_run.erl, function run_test/1: at line 872: syntax error before: '--'
edoc: skipping source file 'src/ct_run.erl': {'EXIT',error}.
src/ct_util.erl, function start/0: at line 80: @spec arity does not match.
edoc: skipping source file 'src/ct_util.erl': {'EXIT',error}.
src/orber_ifr_enumdef.erl: at line 61: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_enumdef.erl': {'EXIT',error}.
edoc: skipping source file 'src/calendar.erl': 
{'EXIT',{{badmatch,{atom,354,'?SECONDS_PER_DAY'}},[{edoc_specs,d2e,1,[{file,[101,100|...]},{line,339}]},{edoc_specs,type,2,[{file,[101|...]},{line,65}]},{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,...}]}}.
src/edoc_types.erl, function is_predefined/2: at line 32: file not 
found: edoc_types.hrl
edoc: skipping source file 'src/edoc_types.erl': {'EXIT',error}.
2543- fatal: {endtag_does_not_match,{was,p,should_have_been,'N'}}
src/ct_repeat.erl, in module header: at line 20: error in XML parser: 
{fatal,  {{endtag_does_not_match,{was,p,should_have_been,'N'}}, 
{file,file_name_unknown},{line,27},{col,33}}}.
edoc: skipping source file 'src/ct_repeat.erl': {'EXIT',error}.
src/ct_logs.erl, function init/2: at line 78: @spec arity does not match.
edoc: skipping source file 'src/ct_logs.erl': {'EXIT',error}.
src/corba_request.erl: at line 278: syntax error before: '?query_check'
edoc: skipping source file 'src/corba_request.erl': {'EXIT',error}.
src/orber_ifr_typecode.erl: at line 67: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_typecode.erl': {'EXIT',error}.
src/orber_ifr_stringdef.erl: at line 48: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_stringdef.erl': {'EXIT',error}.
src/orber_ifr_attributedef.erl: at line 64: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_attributedef.erl': {'EXIT',error}.
src/orber_ifr_wstringdef.erl: at line 46: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_wstringdef.erl': {'EXIT',error}.
src/crypto.erl, function hmac/3: at line 267: multiple @spec tag.
src/crypto.erl, function hmac/3: at line 266: multiple @spec tag.
src/crypto.erl, function hmac/3: at line 265: multiple @spec tag.
src/crypto.erl, function hmac/3: at line 264: multiple @spec tag.
src/crypto.erl, function hmac/3: at line 263: multiple @spec tag.
edoc: skipping source file 'src/crypto.erl': {'EXIT',error}.
src/edoc_doclet.erl, function run/2: at line 38: file not found: 
edoc_doclet.hrl
edoc: skipping source file 'src/edoc_doclet.erl': {'EXIT',error}.
src/ssl_manager.erl, function register_session/3: at line 156: multiple 
@spec tag.
edoc: skipping source file 'src/ssl_manager.erl': {'EXIT',error}.
src/megaco_ber_bin_drv_encoder.erl: at line 277: head mismatch
edoc: skipping source file 'src/megaco_ber_bin_drv_encoder.erl': 
{'EXIT',error}.
src/orber_ifr_sequencedef.erl: at line 53: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_sequencedef.erl': {'EXIT',error}.
src/ssl_pkix_db.erl, function cache_pem_file/2: at line 118: multiple 
@spec tag.
edoc: skipping source file 'src/ssl_pkix_db.erl': {'EXIT',error}.
src/orber_ifr_uniondef.erl: at line 67: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_uniondef.erl': {'EXIT',error}.
src/orber_ifr_structdef.erl: at line 60: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_structdef.erl': {'EXIT',error}.
src/orber_ifr_primitivedef.erl: at line 46: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_primitivedef.erl': {'EXIT',error}.
src/orber_ifr_moduledef.erl: at line 64: syntax error before: '?tcheck'
edoc: skipping source file 'src/orber_ifr_moduledef.erl': {'EXIT',error}.
edoc: error in doclet 'edoc_doclet': {'EXIT',error}.
edoc: edoc terminated abnormally: error.


I've placed all the source file in one directory. I've also tested the 
some libray files in there orginal directory with the same results.

How can I resolve this?

SM.



More information about the erlang-questions mailing list