Browse thread
code links in ocamldoc -intro files
- Eric Breck
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
| Date: | -- (:) |
| From: | Eric Breck <ebreck@c...> |
| Subject: | code links in ocamldoc -intro files |
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