[Caml-list] Re: [Caml-list] Question/Feature request about Camlidl andcomments]

[Caml-list] Re: [Caml-list] Question/Feature request about Camlidl andcomments]

[matthieu.dubuget]

>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

RE: [Caml-list] Re: [Caml-list] Question/Feature request about Camlidl andcomments]

[BdB]

Not solving your problem here, but wouldn't it be more consistent to use a
literate programming tool for IDL? After all, your IDL component may or may
not be implemented in O'CaML...

> -----Message d'origine-----
> De : owner-caml-list@pauillac.inria.fr
> [mailto:owner-caml-list@pauillac.inria.fr]De la part de
> matthieu.dubuget@libertysurf.fr
> Envoyé : mercredi 30 juillet 2003 08:43
> À : caml-list
> Objet : [Caml-list] Re: [Caml-list] Question/Feature request about
> Camlidl andcomments]
>
>
> >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

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