From: Romain Bardou <Romain.Bardou@lri.fr>
To: caml-list <caml-list@yquem.inria.fr>
Subject: Re: [Caml-list] File inclusion with Ocamldoc
Date: Wed, 15 Oct 2008 10:55:09 +0200 [thread overview]
Message-ID: <48F5AFED.5050806@lri.fr> (raw)
In-Reply-To: <552539.25055.qm@web54602.mail.re2.yahoo.com>
>> You can use .txt files to do this. Simply type ocamldoc
>> comment (without (** *)) in a file.txt file and pass it to
>> ocamldoc like any .ml or .mli file. This will be considered
>> as a File module and you can refer to it by {!File} from any
>> ocamldoc comment.
>
> Excellent! Thanks for the tip. Incidentally, the 3.10 version
> of Ocamlbuild does not support the generation of documentation
> from implementation files. Will 3.11 fix this?
It works for me with the 3.10.1. I just tried to write a file test.ml,
and a file truc.odocl with "Test" in it, and then ran ocamlbuild :
ocamlbuild truc.docdic/index.html
And it worked. Or maybe I didn't understand what you want?
--
Romain Bardou
next prev parent reply other threads:[~2008-10-15 8:54 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-10-14 13:51 Dario Teixeira
2008-10-14 17:22 ` [Caml-list] " Maxence Guesdon
2008-10-14 19:17 ` Dario Teixeira
2008-10-15 8:55 ` Romain Bardou [this message]
2008-10-15 14:43 ` Dario Teixeira
2008-10-15 15:05 ` Nicolas Pouillard
2008-10-16 15:27 ` Dario Teixeira
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=48F5AFED.5050806@lri.fr \
--to=romain.bardou@lri.fr \
--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