12085Re: "ocaml_beginners":: Explicit parameter names in .mli files
- Aug 5, 2010On Thu, 2010-08-05 at 09:33 +0000, iainmcgin wrote:
> What I would really like is named parameters, but only forThe standard library accomplishes this via ocamldoc. So, there would be
> documentation purposes, in .mli files, without these names being
> treated as labels, which seem to be the main cause of my problems
> above. Is this possible? If not, through what other means could I
> document what the intent of each parameter is (i.e. ocamldoc
> annotations, etc)?
a definition in the mli like this:
val f: string -> string -> string
(** [f x y] frobnicates x and y, returning the Foo transform *)
I find that to be quite readable in most cases.
- << Previous post in topic Next post in topic >>