[erlang-questions] edoc: cross-referencing standard Erlang functions

Edwin Fine <>
Thu Jul 17 21:16:28 CEST 2008


I am documenting an application using edoc,  and I want to cross-reference a
function in a standard Erlang application, say,
//stdlib/gen_server:start_link/3, without hard-coding a URL like
file:///usr/local/lib/erlang/lib/stdlib-1.15.3/doc/html/gen_server.html#start_link-3.

When I do this in edoc using the syntax //Application/Module:Function/Arity,
it cross references gen_server within my application's directory, so the
generated link does not work. I saw a reference to using edoc-info files,
but couldn't find more detailed information other than edoc would use all
edoc-info files on the path. I could find very few edoc-info files in the
Erlang distro. I got the impression that all the existing Erlang docs would
have to be generated using edoc to generate the appropriate edoc-info files,
but they aren't.

I looked at the edoc docs and source code for 0.7.6 with no further
enlightenment.

Is there some way to do this in edoc that I've missed?

-- 
The great enemy of the truth is very often not the lie -- deliberate,
contrived and dishonest, but the myth, persistent, persuasive, and
unrealistic. Belief in myths allows the comfort of opinion without the
discomfort of thought.
John F. Kennedy 35th president of US 1961-1963 (1917 - 1963)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://erlang.org/pipermail/erlang-questions/attachments/20080717/fe58cb60/attachment.html>


More information about the erlang-questions mailing list