caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
* code links in ocamldoc -intro files
@ 2006-07-14  3:47 Eric Breck
  0 siblings, 0 replies; only message in thread
From: Eric Breck @ 2006-07-14  3:47 UTC (permalink / raw)
  To: caml-list

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


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2006-07-14  3:46 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2006-07-14  3:47 code links in ocamldoc -intro files Eric Breck

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).