Version française
Home     About     Download     Resources     Contact us    
Browse thread
RE: [Caml-list] Re: [Caml-announce] OCamldoc
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Sven <luther@d...>
Subject: Re: [Caml-list] Re: [Caml-announce] OCamldoc
On Tue, Oct 09, 2001 at 01:26:38PM -0400, Maxence Guesdon wrote:
> Dave Berry wrote:
> > Would it be possible for OCamldoc to detect whether the comment follows
> > a definition on the same line?  If so, then you could use this to infer
> > that the comment refers to that definition.  If the comment begins on a
> > new line, the comment would refer to the following definition.
> > 
> 
> In some case, you want to start the comment on the line after, because 
> it 's a long comment, maybe on more than one line, like in
> 
> type t =
>    C of int
>      (** my long comment i didn't want ot start on the line above. *)
> | C2
> 
> so here we don't want to associate this comment to C2 but to C.

But this same argument could be reversed :

type t = 
    C of <insert very long multi line type here>
      (** short comment **)

Here, it makes more sense to have it first.

Friendly,

Sven Luther
-------------------
Bug reports: http://caml.inria.fr/bin/caml-bugs  FAQ: http://caml.inria.fr/FAQ/
To unsubscribe, mail caml-list-request@inria.fr  Archives: http://caml.inria.fr