From b0037e3302c2ab3f99dd866cf3fdf001af34115a Mon Sep 17 00:00:00 2001 From: Stefano Zacchiroli Date: Sat, 8 Sep 2007 09:16:29 +0000 Subject: [PATCH] convert comments to ocamldoc comments --- .../gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli | 18 +++++++++++------- .../ocaml/gdome_xslt/gdome_xslt_init.mli | 14 +++++++------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli b/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli index 8115457f3..7571ef3d2 100644 --- a/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli +++ b/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli @@ -28,21 +28,25 @@ (* processStylesheet stylesheet *) (* Process a stylesheet so that it can be subsequently used *) (* with applyStylesheet. *) + +(** processStylesheet stylesheet + * + * Process a stylesheet so that it can be subsequently used with + * applyStylesheet. *) val processStylesheet: Gdome.document -> I_gdome_xslt.processed_stylesheet -(* applyStylesheet source stylesheet params *) -(* Applies a processed stylesheet to a source document, using *) -(* the given list of parameters (couples name,value) *) +(** applyStylesheet source stylesheet params + * Applies a processed stylesheet to a source document, using the given list of + * parameters (couples name,value) *) val applyStylesheet: source: Gdome.document -> stylesheet:I_gdome_xslt.processed_stylesheet -> params:(string * string) list -> Gdome.document -(* output the result of a previous XSLT transformation to an *) -(* output channel *) +(** output the result of a previous XSLT transformation to an output channel *) val saveResultToChannel: outchan: out_channel -> result: Gdome.document -> @@ -50,10 +54,10 @@ val saveResultToChannel: unit (** set error callback, that is a function invoked each time an error message is -generated. If None is passed, libxslt default error callback is used *) + * generated. If None is passed, libxslt default error callback is used *) val setErrorCallback: (string -> unit) option -> unit (** set debug callback, that is a function invoked each time a debugging message -is generated. If None is passed, libxslt default error callback is used *) + * is generated. If None is passed, libxslt default error callback is used *) val setDebugCallback: (string -> unit) option -> unit diff --git a/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli b/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli index d3e6d670e..84b4f5d75 100644 --- a/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli +++ b/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli @@ -25,13 +25,13 @@ * For more information, please send an email to {sacerdot,zack}@cs.unibo.it *) -(**************************** WARNING!!! ***********************************) -(*** ***) -(*** This file must always be linked with any code using gdome_xslt and ***) -(*** must be linked as the first file. It is responsible of initializing ***) -(*** the whole binding, registering some ocaml values to the C level. ***) -(*** ***) -(***************************************************************************) +(** GDome XSLT initialization module *) + +(** WARNING!!! + * This file must always be linked with any code using gdome_xslt + * and must be linked as the first file. It is responsible of initializing the + * whole binding, registering some ocaml values to the C level. *) exception ProcessStylesheetException exception ApplyStylesheetException + -- 2.39.2