Added ocamldoc, and fixed bugs.

[perl4caml.git] / perl.mli

diff --git a/perl.mli b/perl.mli
index 36cb213..73270d2 100644 (file)
--- a/perl.mli
+++ b/perl.mli
@@ -2,7 +2,7 @@
   *
   * Copyright (C) 2003 Merjis Ltd.
   *
-  * $Id: perl.mli,v 1.7 2003-10-16 08:54:56 rich Exp $
+  * $Id: perl.mli,v 1.8 2003-10-16 13:41:06 rich Exp $
   *)
 
 type t
@@ -115,10 +115,10 @@ val sv_false : unit -> sv
 (** Returns an [SV] which is false. *)
 val sv_yes : unit -> sv
 (** Returns Perl's internal [PL_sv_yes]. (There are some unresolved issues
-  * with using this, so use {!sv_true} instead). *)
+  * with using this, so use {!Perl.sv_true} instead). *)
 val sv_no : unit -> sv
 (** Returns Perl's internal [PL_sv_no]. (There are some unresolved issues
-  * with using this, so use {!sv_false} instead). *)
+  * with using this, so use {!Perl.sv_false} instead). *)
 
 (* Actually there are many more types defined than this ... *)
 type sv_t    = SVt_NULL
@@ -161,16 +161,17 @@ val av_empty : unit -> av
 val av_of_sv_list : sv list -> av
 (** Create an array from a list of [SVs]. *)
 val av_push : av -> sv -> unit
-(** Append the [SV] to the end of the array. Same as Perl [push @av, $sv]. *)
+(** Append the [SV] to the end of the array. Same as Perl
+  * [push \@av, $sv]. *)
 val av_pop : av -> sv
 (** Remove the [SV] at the end of the array and return it. Same as
-  * Perl [$sv = pop @av]. *)
+  * Perl [$sv = pop \@av]. *)
 val av_shift : av -> sv
 (** Remove the [SV] at the beginning of the array and return it. Same as
-  * Perl [$sv = shift @av]. *)
+  * Perl [$sv = shift \@av]. *)
 val av_unshift : av -> sv -> unit
 (** Prepend the [SV] to the start of the array. Same as Perl
-  * [unshift @av, $sv]. *)
+  * [unshift \@av, $sv]. *)
 val av_length : av -> int
 (** Return the length of the [AV]. *)
 val av_set : av -> int -> sv -> unit
@@ -178,9 +179,9 @@ val av_set : av -> int -> sv -> unit
 val av_get : av -> int -> sv
 (** Get the i'th element of the [AV]. *)
 val av_clear : av -> unit
-(** Remove all elements from the [AV]. Same as Perl [@av = ()]. *)
+(** Remove all elements from the [AV]. Same as Perl [\@av = ()]. *)
 val av_undef : av -> unit
-(** Delete the [AV] (and all elements in it). Same as Perl [undef @av]. *)
+(** Delete the [AV] (and all elements in it). Same as Perl [undef \@av]. *)
 val av_extend : av -> int -> unit
 (** Extend the [AV] so it contains at least [n+1] elements. *)
 val av_map : (sv -> 'a) -> av -> 'a list
@@ -198,13 +199,14 @@ val get_sv : ?create:bool -> string -> sv
   * this function will return the [SV] for [undef].
   *)
 val get_av : ?create:bool -> string -> av
-(** Same as {!get_sv} except will return and/or create [@a]. *)
+(** Same as {!Perl.get_sv} except will return and/or create [\@a]. *)
 
 val call : ?sv:sv -> ?fn:string -> sv list -> sv
 (** Call a Perl function in a scalar context, either by name (using the [?fn]
   * parameter) or by calling a string/CODEREF (using the [?sv] parameter).
   *
-  * Returns the Perl [SV] containing the result value. (See {!int_of_sv} etc.).
+  * Returns the Perl [SV] containing the result value. (See
+  * {!Perl.int_of_sv} etc.).
   *
   * If the Perl code calls [die] then this will throw [Perl_failure].
   *)