caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: "matthieu.dubuget@libertysurf.fr" <matthieu.dubuget@libertysurf.fr>
To: caml-list <caml-list@inria.fr>
Subject: [Caml-list]  Re: [Caml-list] Question/Feature request about Camlidl andcomments]
Date: Wed, 30 Jul 2003 08:42:30 +0200	[thread overview]
Message-ID: <HITRYU$76CE8827F52A1FA020A35343B7932268@tiscali.fr> (raw)

>Depending on what you base your ocamldoc generation,
>use either ml or mli. Since i think mli is the best
>place to do it i will use it :

>quote(mli,"(** This is a ocamldoc comment *)");

>int my_function ( [string] const char * msg );

>Simple !

I should have explained in detail what I was trying to do.

I did an attempt to do what you are suggesting. The problem
is that it seems difficult to control where the comments
will appear in the generated mli files.

For example, if I try 
quote(mli,"** This is a module *)"); at the very beginning
of my idl file in order to generate a comment to be
associated with the whole module, the string appears between
types definitions and functions definitions, which is not
what we need to conform to ocamldoc. An other point was that
I wanted to comment also the elements of enums.

I may have the time to look at camlidl source code during my
holidays...

Salutations

Matthieu Dubuget





********** L'ADSL A 20 EUR/MOIS**********
Tiscali propose l'ADSL le moins cher du marché : 20 EUR/mois et le modem ADSL offert ! 
Pour profiter de cette offre exceptionnelle, cliquez ici : http://register.tiscali.fr/adsl/
Offre soumise à conditions.


-------------------
To unsubscribe, mail caml-list-request@inria.fr Archives: http://caml.inria.fr
Bug reports: http://caml.inria.fr/bin/caml-bugs FAQ: http://caml.inria.fr/FAQ/
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners


             reply	other threads:[~2003-07-30  6:42 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-07-30  6:42 matthieu.dubuget [this message]
2003-07-30  7:53 ` BdB

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='HITRYU$76CE8827F52A1FA020A35343B7932268@tiscali.fr' \
    --to=matthieu.dubuget@libertysurf.fr \
    --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).