From: Hendrik Tews <tews@os.inf.tu-dresden.de>
To: caml-list@yquem.inria.fr
Subject: Re: [Caml-list] ocamldoc: Howto crossreference another library?
Date: Tue, 13 Mar 2012 16:26:11 +0100 [thread overview]
Message-ID: <6x62e88quk.fsf@blau.inf.tu-dresden.de> (raw)
In-Reply-To: <20120307101101.2629f29d@alcazar> (Maxence Guesdon's message of "Wed, 7 Mar 2012 10:11:01 +0100")
Maxence Guesdon <Maxence.Guesdon@inria.fr> writes:
Hendrik Tews <tews@os.inf.tu-dresden.de> wrote:
>
> (** Uses {!print_endline} *)
> let f () = print_endline "Hello"
>
> What do I have to do such that ocamldoc generates a
> crossreference to
> file:///usr/share/doc/ocaml-doc/ocaml.html/libref/Pervasives.html#VALprint_endline
> ?
OCamldoc can only create links to elements it knows about, i.e. in modules
given on command line (or loaded from a dump).
So the answer is: you can't.
After some discussion in the bug tracker, it turns out that one
can get pretty far with a ocamldoc custom generator that uses the
undocumented feature of custom text elements.
See http://askra.de/software/misc/odoc_xref.ml for my preliminary
version of such a generator.
Bye,
Hendrik
prev parent reply other threads:[~2012-03-13 15:26 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-07 8:58 Hendrik Tews
2012-03-07 9:11 ` Maxence Guesdon
2012-03-12 8:28 ` Hendrik Tews
2012-03-13 15:26 ` Hendrik Tews [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6x62e88quk.fsf@blau.inf.tu-dresden.de \
--to=tews@os.inf.tu-dresden.de \
--cc=caml-list@yquem.inria.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox