caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Francois Ripault <fr.ripault@gmail.com>
To: Kenichi Asai <asai@is.ocha.ac.jp>
Cc: caml-list@inria.fr
Subject: Re: [Caml-list] OCamlDoc for multiple languages?
Date: Wed, 26 Nov 2014 22:45:54 -0800	[thread overview]
Message-ID: <CAEN5GRPy7Rczv4uStmdGfPNY1Rj7osKtok3+UG=4_gA2y416wQ@mail.gmail.com> (raw)
In-Reply-To: <20141127062001.GA4529@pllab.is.ocha.ac.jp>

[-- Attachment #1: Type: text/plain, Size: 1470 bytes --]

Hi,

It seems that what you are looking for is defining custom tags (
http://caml.inria.fr/pub/docs/manual-ocaml-400/manual029.html#s:ocamldoc-custom-tags).
Defining a generator to handle those tags is also explained in the
documentation.

Regards,

François

On Wed, Nov 26, 2014 at 10:20 PM, Kenichi Asai <asai@is.ocha.ac.jp> wrote:

> Dear all,
>
> > One of my students is porting the universe teachpack of Racket into
> > OCaml, which enables easy game programming similarly to Racket.
> > I am now encouraging her to make the library public...
>
> One of the issues in making the library public is that the ocamldoc
> comments in mli files are written in Japanese.  (This is important for
> my Japanese students.)  What is a good way to provide ocamldoc
> comments in multiple languages?  I can only think of having many mli
> files for each language, like:
>
> foo.mli.ja      for Japanese
> foo.mli.en      for English
>
> and make foo.mli as a link to one of them.  But ideally, I want to
> keep only one mli file with multiple comments and choose one of them
> depending on which language's document I want to create.
>
> Thank you in advance.
>
> Sincerely,
>
> --
> Kenichi Asai
>
> --
> Caml-list mailing list.  Subscription management and archives:
> https://sympa.inria.fr/sympa/arc/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs
>

[-- Attachment #2: Type: text/html, Size: 2280 bytes --]

      reply	other threads:[~2014-11-27  6:46 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-27  6:20 Kenichi Asai
2014-11-27  6:45 ` Francois Ripault [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='CAEN5GRPy7Rczv4uStmdGfPNY1Rj7osKtok3+UG=4_gA2y416wQ@mail.gmail.com' \
    --to=fr.ripault@gmail.com \
    --cc=asai@is.ocha.ac.jp \
    --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).