From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Sat, 8 Sep 2007 09:16:29 +0000 (+0000)
Subject: convert comments to ocamldoc comments
X-Git-Tag: make_still_working~6060
X-Git-Url: http://matita.cs.unibo.it/gitweb/?a=commitdiff_plain;h=e1e2673eb6bfa39d9e1b7798202f959ff85d2195;p=helm.git

convert comments to ocamldoc comments
---

diff --git a/helm/software/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli b/helm/software/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli
index 8115457f3..7571ef3d2 100644
--- a/helm/software/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt.mli
+++ b/helm/software/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/helm/software/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli b/helm/software/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli
index d3e6d670e..84b4f5d75 100644
--- a/helm/software/DEVEL/gdome_xslt/ocaml/gdome_xslt/gdome_xslt_init.mli
+++ b/helm/software/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
+