From mboxrd@z Thu Jan  1 00:00:00 1970
Received: (from majordomo@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id RAA22339; Wed, 10 Oct 2001 17:39:09 +0200 (MET DST)
X-Authentication-Warning: pauillac.inria.fr: majordomo set sender to owner-caml-list@pauillac.inria.fr using -f
Received: from nez-perce.inria.fr (nez-perce.inria.fr [192.93.2.78]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id RAA22271 for <caml-list@pauillac.inria.fr>; Wed, 10 Oct 2001 17:39:08 +0200 (MET DST)
Received: from saul.cis.upenn.edu (SAUL.CIS.UPENN.EDU [158.130.12.4])
	by nez-perce.inria.fr (8.11.1/8.10.0) with ESMTP id f9AFd6103818
	for <caml-list@inria.fr>; Wed, 10 Oct 2001 17:39:06 +0200 (MET DST)
Received: from localhost (localhost [127.0.0.1])
	by saul.cis.upenn.edu (8.10.1/8.10.1) with SMTP id f9AFd1x15208;
	Wed, 10 Oct 2001 11:39:01 -0400 (EDT)
To: "Stefano Lanzavecchia" <stf@apl.it>
cc: caml-list@inria.fr
Reply-to: bcpierce@cis.upenn.edu
Subject: Re: [Caml-list] Re: [Caml-announce] OCamldoc 
In-reply-to: Your message of Wed, 10 Oct 2001 17:25:16 +0200.
             <001501c1519f$c88ae400$58a4b9c2@MADOKA> 
Date: Wed, 10 Oct 2001 11:39:01 EDT
Message-ID: <15204.1002728341@saul.cis.upenn.edu>
From: "Benjamin C. Pierce" <bcpierce@saul.cis.upenn.edu>
Sender: owner-caml-list@pauillac.inria.fr
Precedence: bulk

> > Is there *anyone* that wants to write
> > 
> >       (* Comment for f *)
> >   val f : t
> >       (* Comment for g *)
> >   val g : t'
> 
> You mean, anyone who normally, when writing programs, either puts the
> comment before the thing being commented, or 
> 
>    val f : t  (* Comment for f *)
>    val g : t' (* Comment for g *)
> 
> on the same line as the thing being commented? 

No, I meant, anyone who writes comments before the thing that they refer
to *and* indented more than the thing that follows them.

My proposed rule

    if the comment is on a line by itself, 
    then if its indentation is the same as the following (non-comment) line
         then it goes with the following
         else it goes with the preceding
    else it goes with the line it's on.

handles your style just fine, I think.  The idea was to support all three
"natural" styles, i.e.

     (** comment for f *)
     val f : t

     val f : t   (** comment for f *)
     
     val f : t   
        (** comment for f *)
     
without the need for any funny markers.

   B



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