edoc question

Richard Carlsson <>
Tue Aug 22 14:35:20 CEST 2006


dda wrote:
> Thank you for the info. I heard yesterday about the @headerfile tag,
> but this brought its own problems:
> 
> 20> edoc:file("src/mb.erl").
> src/test.hrl: warning: documentation before function definitions is
> ignored by @headerfile
> src/encodings.hrl: warning: documentation before function definitions
> is ignored by @headerfile
> [...]
> ok
> 
> I put the
> %% @headerfile "test.hrl"
> [...]
> right after the -include("...hrl") directives. Doesn't seem to work.
> The edoc tags I put in the .hrl files were the same as in .erl files
> [@spec, @doc, @see etc], and someone mentioned the set of allowed tags
> in .hrl may be more restricted. Any thoughts?

Did you put function definitions in the header file?

	/Richard




More information about the erlang-questions mailing list