caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Eric Breck <ebreck@cs.cornell.edu>
To: caml-list@inria.fr
Subject: code links in ocamldoc -intro files
Date: Thu, 13 Jul 2006 23:47:13 -0400	[thread overview]
Message-ID: <8E45EB16-449E-4464-8E0F-11270568978C@cs.cornell.edu> (raw)

Hi folks,

Is this a bug?

ocamldoc has the "-intro" option, letting you provide a file in  
ocamldoc comment form, which is formatted like a code comment,  
becoming the intro page of your documentation.  But it behaves  
slightly differently from a code comment - code links don't work.

test.ml is

   let to_string () = "()"

intro.camldoc is

   Reference to {!Test.to_string}

intro.ml is just like intro.camldoc but enclosed in (** / *)

now

ocamldoc -html intro.ml test.ml

ocamldoc -html -intro intro.camldoc test.ml

both format the text in intro.  Apart from navigation info, they're  
formatted the same - except that for intro.ml, {!Test.to_string}  
turns into a hyperlink to Test.html#VALto_string, and in  
intro.camldoc, it doesn't.

Any idea why?

best,

Eric Breck


                 reply	other threads:[~2006-07-14  3:46 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=8E45EB16-449E-4464-8E0F-11270568978C@cs.cornell.edu \
    --to=ebreck@cs.cornell.edu \
    --cc=caml-list@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;
as well as URLs for NNTP newsgroup(s).