X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=generator%2Fgenerator_utils.mli;h=5104a1620f4f72039ae0652fe8701770999fe8cf;hb=fdc8805362c6fc587bb7985c5290362ad3094f4e;hp=f43a276d1051de4ca1907abf2cbc20e66e6e95b1;hpb=0003ea2c3dbaa7e22f4f616539136821d80694b8;p=libguestfs.git diff --git a/generator/generator_utils.mli b/generator/generator_utils.mli index f43a276..5104a16 100644 --- a/generator/generator_utils.mli +++ b/generator/generator_utils.mli @@ -91,11 +91,26 @@ val seq_of_test : Generator_types.test -> Generator_types.seq val c_quote : string -> string (** Perform quoting on a string so it is safe to include in a C source file. *) -val pod2text : width:int -> string -> string -> string list -(** [pod2text ~width name longdesc] converts the POD in [longdesc] to - plain ASCII lines of text. This is the slowest part of - autogeneration, so the results are memoized into a temporary - file. *) +val pod2text : ?width:int -> ?trim:bool -> ?discard:bool -> string -> string -> string list + (** [pod2text ?width ?trim ?discard name longdesc] converts the POD in + [longdesc] to plain ASCII lines of text. + + [width] is the width in characters. If not specified, then + use the pod2text default. + + [trim] means trim the left margin (useful when including the + output inside comments, as in Java generator). + + [discard] means discard the first heading. + + This is the slowest part of autogeneration, so the results are + memoized into a temporary file. *) val action_compare : Generator_types.action -> Generator_types.action -> int -(** Compare the names of two actions, for sorting. *) + (** Compare the names of two actions, for sorting. *) + +val chars : char -> int -> string +(** [chars c n] creates a string containing character c repeated n times. *) + +val spaces : int -> string +(** [spaces n] creates a string of n spaces. *)