Version française
Home     About     Download     Resources     Contact us    
Browse thread
[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: rbw3@c...
Subject: Re: [Caml-list] Re: [Caml-announce] OCamldoc

doxygen (a C++ doc tool, see http://www.stack.nl/~dimitri/doxygen/ ) adds
the '<' only for comments following, keeping the normal notation for
preceding ones, as follows. I just thought I'd mention it to give more
ideas.

(** My magical function *)
let magical = function
  | CaseA -> 0 (*< this is case 0 *)
  | CaseB -> 1 (*< this is case 1 *)
  | CaseC -> 2 (*< this is case 2 *)
  | _ -> raise Not_found (*< Too bad, so sad *)


--Brock


On Tue, 9 Oct 2001, Maxence Guesdon wrote:
| > What about the following syntax?
| > - The comment is before the element:
| >       (** fun 1 *)
| >       val f : t
| >       (** fun 2 *)
| >       val g : u
| > - The comment is after the element:
| >       val f : t
| >         (* fun 1 **)
| >       val g : u
| >         (* fun 2 **)
|
| I must admit i'd rather keep very simple placement rules.
|
| --
| Maxence
-------------------
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