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

hm. I just noticed that I actually made a small mistake in my example. It
should be:

(** 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 *)


with the added '*' in the after-comments. Funnily enough I like my mistaken
one better :)

--Brock

PS.
  Though I've seen this reply to me email, I haven't seen my original
  email yet. Just thought I'd share the speed of processing on the list
  from my vantage point.

On Wed, 10 Oct 2001, Francois Pottier wrote:

|
| > 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 *)
|
| Looks nice to me.
|
| --
| François Pottier
-------------------
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