caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Kenichi Asai <asai@is.ocha.ac.jp>
To: caml-list@inria.fr
Subject: [Caml-list] OCamlDoc: @-tags handled only in the standard elements?
Date: Tue, 9 Dec 2014 15:42:23 +0900	[thread overview]
Message-ID: <20141209064223.GA501@pllab.is.ocha.ac.jp> (raw)

I thought I could provide documents in two languages using custom tags
in OCamlDoc, but there still remains a problem.  It appears that the
custom tags (in my case, @en and @jp) are not handled in

- the very first comment,
- special comments between elements, and
- comments for type constructors, etc.

Is there any way to support custom tags in all the places including
the above?  -- Currently, it seems not, as the OCamlDoc says:

http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html

Section 15.2.1:

> (** Special comments can be placed between elements and are kept
>     by the OCamldoc tool, but are not associated to any element.
>     @-tags in these comments are ignored.*)

Section 15.2.3:

> Some elements support only a subset of all @-tags. Tags that are not
> relevant to the documented element are simply ignored. For instance,
> all tags are ignored when documenting type constructors, record
> fields, and class inheritance clauses. Similarly, a @param tag on a
> class instance variable is ignored.

Why aren't all the comments handled in the same way?  It appears to be
easier to handle all the comments in the same way.  Is there any
chance that it will become as such?

Sincerely,

-- 
Kenichi Asai

             reply	other threads:[~2014-12-09  6:42 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-09  6:42 Kenichi Asai [this message]
2014-12-09  7:38 ` Gabriel Scherer
2014-12-09 11:18   ` Kenichi Asai

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=20141209064223.GA501@pllab.is.ocha.ac.jp \
    --to=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).