[Caml-list] automatic extaction of the .mli (and a little more) from the .ml

Article View: fa.caml

Article #27

#27

From: Francois Berenger
Date: Fri, 31 May 2013 03:43

31 lines
3386 bytes

Hello,

Is there some recommended tool/script to generate a .mli
from the corresponding .ml?

I want a little more than ocamlc -i:

- I think there should be tags in the .ml file as comments
   that say "export this" to the .mli.
   By default, things are not exported.
- maybe it should have an option to say to replicate
   the ocamldoc comments in the .mli.
- it could be nice if the order in which things are exported
   to the .mli can be specified, maybe as an argument of the tag.
   So that the .mli can be more readable (only backward references
   to concepts, etc.)

If there is a need to create a tool, let's call it "nomli". :)

Regards,
F.

PS: I'm not going to maintain both a .mli and a .ml.
     I feel it is a dumb and error-prone job and that
     itches me.

-- 
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

Technical Details

Message-ID: <fa.ysPYFL5+u0NnfGu8UBtNleD9SeQ@ifi.uio.no>

Path:

arc1-ca.pugleaf.net!bp1ni28095pbd.1!nntp.google.com!border1.nntp.dca.giganews.com!nntp.giganews.com!goblin1!goblin.stu.neva.ru!uio.no!nntp.uio.no!.POSTED!not-for-mail

Show Full Headers

Complete Article Headers

X-Google-Thread: c0fe4b917e,bcac4a6e27ff55dd,start
X-Google-Attributes: gidc0fe4b917e,public,usenet
X-Google-NewGroupId: yes
X-Google-Language: ENGLISH,ASCII-7-bit
X-Received: by 10.66.250.226 with SMTP id zf2mr1956981pac.18.1369971830759;
        Thu, 30 May 2013 20:43:50 -0700 (PDT)
Path: arc1-ca.pugleaf.net!bp1ni28095pbd.1!nntp.google.com!border1.nntp.dca.giganews.com!nntp.giganews.com!goblin1!goblin.stu.neva.ru!uio.no!nntp.uio.no!.POSTED!not-for-mail
From: Francois Berenger <berenger@riken.jp>
Newsgroups: fa.caml
Subject: [Caml-list] automatic extaction of the .mli (and a little more)
 from the .ml
Date: Fri, 31 May 2013 03:43:50 UTC
Organization: Internet mailing list
Lines: 31
Sender: caml-list-request@inria.fr
Message-ID: <fa.ysPYFL5+u0NnfGu8UBtNleD9SeQ@ifi.uio.no>
NNTP-Posting-Host: mail-jess.uio.no
Mime-Version: 1.0
X-Trace: readme.uio.no 1369971830 3355 129.240.7.9 (31 May 2013 03:43:50 GMT)
X-Complaints-To: abuse@uio.no
NNTP-Posting-Date: Fri, 31 May 2013 03:43:50 +0000 (UTC)
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130510 Thunderbird/17.0.6
To: caml-list <caml-list@inria.fr>
X-IronPort-AV: E=Sophos;i="4.87,776,1363129200"; 
   d="scan'208";a="19712519"
X-Original-To: caml-list@sympa.inria.fr
Delivered-To: caml-list@sympa.inria.fr
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: AgMBACsbqFGGoCGhh2dsb2JhbABagzq/fg4BAQEIDQkHFiiCYn00AkwNCAEBiAmaU6BtknoDiR6KT4NRhh6OQA
X-IPAS-Result: AgMBACsbqFGGoCGhh2dsb2JhbABagzq/fg4BAQEIDQkHFiiCYn00AkwNCAEBiAmaU6BtknoDiR6KT4NRhh6OQA
X-IronPort-AV: E=Sophos;i="4.87,776,1363129200"; 
   d="scan'208";a="19712489"
X-PMX-Version: 6.0.0.2142326, Antispam-Engine: 2.7.2.2107409, Antispam-Data: 2013.5.31.33044
X-Sequence: 6852
X-no-archive: yes
List-Id: <caml-list.inria.fr>
List-Archive: <http://sympa.inria.fr/sympa/arc/caml-list>
List-Help: <mailto:sympa_inria@inria.fr?subject=help>
List-Owner: <mailto:caml-list-request@inria.fr>
List-Post: <mailto:caml-list@inria.fr>
List-Subscribe: <mailto:sympa_inria@inria.fr?subject=subscribe%20caml-list>
List-Unsubscribe: <mailto:sympa_inria@inria.fr?subject=unsubscribe%20caml-list>
Original-Date: Fri, 31 May 2013 12:43:35 +0900
Original-Message-Id: <51A81C67.50902@riken.jp>
Bytes: 3076
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit