From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Original-To: caml-list@sympa.inria.fr Delivered-To: caml-list@sympa.inria.fr Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by sympa.inria.fr (Postfix) with ESMTPS id 45ABE7FB0A for ; Tue, 9 Dec 2014 12:19:15 +0100 (CET) Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of asai@is.ocha.ac.jp) identity=pra; client-ip=133.65.64.10; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="asai@is.ocha.ac.jp"; x-sender="asai@is.ocha.ac.jp"; x-conformance=sidf_compatible Received-SPF: Pass (mail3-smtp-sop.national.inria.fr: domain of asai@is.ocha.ac.jp designates 133.65.64.10 as permitted sender) identity=mailfrom; client-ip=133.65.64.10; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="asai@is.ocha.ac.jp"; x-sender="asai@is.ocha.ac.jp"; x-conformance=sidf_compatible; x-record-type="v=spf1" Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of postmaster@web.is.ocha.ac.jp) identity=helo; client-ip=133.65.64.10; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="asai@is.ocha.ac.jp"; x-sender="postmaster@web.is.ocha.ac.jp"; x-conformance=sidf_compatible X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: ArsAACLahlSFQUAKl2dsb2JhbABZg1hYgwWzMYI3jTGGCQIcgQ0WAQEBAQERAQEBAQEIFgdChAIBAQEDARIRSwUGBQsLGAkEHQICAg0FIAEFAQoYExIQiAIDCQcBBQizDT0xiy+RJgNThRwBAQEBAQEBAQEBAQEBAQEBAQEaCpAyB4JvMoEVBYQrBoUQhi6BKE9thE4BgQ0wjE+BcDeFNGABgkIBAQE X-IPAS-Result: ArsAACLahlSFQUAKl2dsb2JhbABZg1hYgwWzMYI3jTGGCQIcgQ0WAQEBAQERAQEBAQEIFgdChAIBAQEDARIRSwUGBQsLGAkEHQICAg0FIAEFAQoYExIQiAIDCQcBBQizDT0xiy+RJgNThRwBAQEBAQEBAQEBAQEBAQEBAQEaCpAyB4JvMoEVBYQrBoUQhi6BKE9thE4BgQ0wjE+BcDeFNGABgkIBAQE X-IronPort-AV: E=Sophos;i="5.07,544,1413237600"; d="ml'?mli'?gz'50?scan'50,208,49,50";a="92498833" Received: from web.is.ocha.ac.jp ([133.65.64.10]) by mail3-smtp-sop.national.inria.fr with ESMTP; 09 Dec 2014 12:19:12 +0100 Received: from mail-pd0-f176.google.com (mail-pd0-f176.google.com [209.85.192.176]) by web.is.ocha.ac.jp (Postfix) with ESMTP id 6026299685F for ; Tue, 9 Dec 2014 20:18:51 +0900 (JST) Received: by mail-pd0-f176.google.com with SMTP id y10so363905pdj.35 for ; Tue, 09 Dec 2014 03:19:10 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-type:content-disposition:in-reply-to :user-agent; bh=I/dQXVV/V69OixW6NQOopBj9a+qz+kFb6shB1UJMgBQ=; b=k6R8UidkTsgdDTkYpRMTwYkPf0tfYlbg2MAQBKPuZn20X21mP1A2pksXD6sp4DO/LF 9H3EVJA1kXnuzeqUTN/KWaGL+PmFA1YVRkIFNoHq1/cHN99LmBw/tdDKMHynnFbA8x2v 6GJ9fivvhI77EI4ttTs4R5oCJGxc5wJeWkk1FJV5Q7byVuyjuL6QTk/3j1KNeoqtU9Yh i/fB4LflHsy1e6JEjfiivZTYOPfHIMBLaKDbm2M4PNee+fIbQy0626m9mk2zqYl8Vr6m xSEf9XtsGKH30bs/gyvfUhrLQ9HC8q8CjL2RPwfXL5w6FpaR020sOYRcAJ9psl79AtMy UzpQ== X-Gm-Message-State: ALoCoQnJLewelNWvOigwhQSR7hqlMFC64z5evHhggVDGsCUz/6ZebWUqLzBiw/VaYxS0Mi3d/yBZR7jGKoRBbTe9gEVx5+QSMcKzJa/Gp3rruUPUkZSTSq7PU6liiN9X0nCSJk4R+/Nm X-Received: by 10.70.43.68 with SMTP id u4mr30220208pdl.6.1418123950601; Tue, 09 Dec 2014 03:19:10 -0800 (PST) X-Received: by 10.70.43.68 with SMTP id u4mr30220045pdl.6.1418123949289; Tue, 09 Dec 2014 03:19:09 -0800 (PST) Received: from localhost (cb8ae2-013.dynamic.tiki.ne.jp. [203.138.226.13]) by mx.google.com with ESMTPSA id c17sm1264811pdl.6.2014.12.09.03.19.07 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Tue, 09 Dec 2014 03:19:08 -0800 (PST) Date: Tue, 9 Dec 2014 20:18:45 +0900 From: Kenichi Asai To: Gabriel Scherer Cc: caml users Message-ID: <20141209111845.GA9412@pllab.is.ocha.ac.jp> References: <20141209064223.GA501@pllab.is.ocha.ac.jp> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="liOOAslEiF7prFVr" Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.23 (2014-03-12) Subject: Re: [Caml-list] OCamlDoc: @-tags handled only in the standard elements? --liOOAslEiF7prFVr Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable > Do you have the sources of your current experiment available somewhere for > testing and reproduction? Thank you for the e-mail. I created a very small example attached. When you run "make" in the test directory, html documents are created in the html-* directories. I want the following: - I want the first text "module header in *" to appear in index.html. (If I remove "@en", the text appears there.) - I want the two "Session header" texts to appear in Test.html. - I want the the texts for "A" and "B" to appear in Test.html. In a nutshell, I want all the @en texts to appear and @ja texts to disappear when I pass "-lang en" (and likewise for "-lang ja"). Sincerely, --=20 Kenichi Asai On Tue, Dec 09, 2014 at 08:38:45AM +0100, Gabriel Scherer wrote: > My understanding is that these parts of the documentation describe the be= havior > of the generators provided by ocamldoc. If you implement a custom generat= or to > handle those custom tags (Section 15.3), you should be able to override t= his > behavior with whatever pleases you. If the current implementation does not > allow that, you should file a feature request and indeed it seems reasona= ble to > extend it suitably. >=20 > Do you have the sources of your current experiment available somewhere for > testing and reproduction? >=20 > On Tue, Dec 9, 2014 at 7:42 AM, Kenichi Asai wrote: >=20 > I thought I could provide documents in two languages using custom tags > in OCamlDoc, but there still remains a problem.=C2=A0 It appears that= the > custom tags (in my case, @en and @jp) are not handled in >=20 > - the very first comment, > - special comments between elements, and > - comments for type constructors, etc. >=20 > Is there any way to support custom tags in all the places including > the above?=C2=A0 -- Currently, it seems not, as the OCamlDoc says: >=20 > http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.html >=20 > Section 15.2.1: >=20 > > (** Special comments can be placed between elements and are kept > >=C2=A0 =C2=A0 =C2=A0by the OCamldoc tool, but are not associated to = any element. > >=C2=A0 =C2=A0 =C2=A0@-tags in these comments are ignored.*) >=20 > Section 15.2.3: >=20 > > 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. >=20 > Why aren't all the comments handled in the same way?=C2=A0 It appears= to be > easier to handle all the comments in the same way.=C2=A0 Is there any > chance that it will become as such? >=20 > Sincerely, >=20=20=20=20 > -- > Kenichi Asai >=20 > -- > Caml-list mailing list.=C2=A0 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 --liOOAslEiF7prFVr Content-Type: application/x-tar-gz Content-Disposition: attachment; filename="test.tar.gz" Content-Transfer-Encoding: base64 H4sIAOfVhlQCA+1YW4/iNhTmlfyKU/oCdAiBSUBlO9XOSNVsq65W6vatUyFP cELYxEa2M5qp9sf32LmQDAzbi4ZSyUciDvbnz+cW3xSVatx5XfE8bx4EYMpZ UXpTvyhLgcnU9ydBMJ3N5+BNppPLaQeCzgkkl4oIVIVIkhzDISyKjhup7ajL /4koHf8QncAzN0tfLf4z338x/pPAn5Xx92f+xMP4X87nXgc8G/9Xl/5wCClh cU5iCorEC+hR1oOIC/iBxWki1xfQ25Ci5ieyJYxKCsOBk1JlOsIVCBqZXo6T 8VWeUriljAqisEf/FhbwYcXD5VplqfsOH8u4ah3AlSOVyEPlAIQpkRI0CmsB hd9vaKj6kqbRwFQAJGxNRaLg1tU4p6zVJoR8m9AVRIJnQETM1QKp1HYxHpt/ 7uO3oRsJrXfRJ6NqzVewFckDURRQi4TFSx4tFX1UYB5XTlfbeJ9HEdp4gwUV biioxk+DGSrjdLVyX2td6q4Grt/eON2qD2eKMiVNW1PpX6jKBYN3v77/GQ1Y UeNjtaYQJw+UFVrwCEjhZwyO+6IBlQ4F0qiPQ8ATz0VBjY4zYStUPmCvU/s4 UQlJkz+oKGtAD72MchaqhDMJ342g/5Ue6AJa9uuqASwWbbjT1aYKGidSUQGc pU9gersAH9BYoeESg0YhiRkXGEVjJGUrR/9Moi3RnHukYNhgsgmjKl2yWi35 Vo9iNO33Rpq3dwHXInY/UrUszIRC195vlH3ekN/v2J26U2WK0irLAVnzDMPU G7xpDYKuQTVM+u4yF/p7mV6mOUKKLDcOwBw3Rpz5/K+NG1E2PoP1PwjM/I8L gV3/Tx3/EX5M47OIvz+18T91/DfknL7/wMb/5PE/p+/fxv+E8X9PPtEoSenr ff9Hz38Tf17H359d6u8/mM3s+e8UQtIUt6542tgQfLo4A+CbLhzcuGJLeTUQ Zhx0qrhZmjhdHpIsxd0ujOImYLSCcicBZicO5hBTdnJwgH9Ghx0LOnzZ0TWA NS2eCQsypPoRvtnxhg2EU5rZUOZRHtDGgJoaIWpn4ci0HrLyX5MXE/FRmxG9 b7Tp1DJbrok+T414a5yGK8KUEoyy0xUZjCIYIiAxT26ej8VTYqEr7smnCtnc MQ6balf/8DRR14+HTsfKGc//VYb9R/P/5bRe/z3PL+b/+cTO/6e6/3uLM1h5 n7GmZEUFJKy6FzE3K29xFtoDNC8DnYrmI5Uy4ayCmQutpy2VhxiPYVvkuhZU PYa5sjLoQ6zt1gM8U7iCa9gju26Sdaubrxbj9XPG7me42We6+TLTzd9x4ANJ 87/swR24RY/VZh2p7+Vw/UgYrhffPysOubnV76jLnyMP62B0RAVeGqto/+JA Naw5ip3RrVixYsWKFStWrFixYuWw/AmoOmXdACgAAA== --liOOAslEiF7prFVr--