From 776e29c4cbb08520459c267fb7331560976d5f02 Mon Sep 17 00:00:00 2001
From: Stefano Zacchiroli <zack@upsilon.cc>
Date: Sat, 8 Sep 2007 10:11:43 +0000
Subject: [PATCH] * add ocamldoc comments to .mli interface files

---
 DEVEL/lablgtkmathview/debian/changelog |  5 +++--
 DEVEL/lablgtkmathview/gMathView.mli    | 12 +++++++++++-
 DEVEL/lablgtkmathview/gMathViewAux.mli | 11 +++++++++++
 3 files changed, 25 insertions(+), 3 deletions(-)

diff --git a/DEVEL/lablgtkmathview/debian/changelog b/DEVEL/lablgtkmathview/debian/changelog
index c2107bea7..91003c55a 100644
--- a/DEVEL/lablgtkmathview/debian/changelog
+++ b/DEVEL/lablgtkmathview/debian/changelog
@@ -1,12 +1,13 @@
-lablgtkmathview (0.7.3-3) unstable; urgency=low
+lablgtkmathview (0.7.8-1) unstable; urgency=low
 
+  * add ocamldoc comments to .mli interface files
   * debian/control
     - port Vcs-Svn field to the new syntax
     - add XS-Vcs-Browser field pointing to HELM's repository browser
   * debian/rules
     - enable ocamldoc api reference generation (via CDBS)
 
- -- Stefano Zacchiroli <zack@debian.org>  Sat, 08 Sep 2007 11:53:07 +0200
+ -- Stefano Zacchiroli <zack@debian.org>  Sat, 08 Sep 2007 12:10:44 +0200
 
 lablgtkmathview (0.7.3-2) experimental; urgency=low
 
diff --git a/DEVEL/lablgtkmathview/gMathView.mli b/DEVEL/lablgtkmathview/gMathView.mli
index d116c527d..082992091 100644
--- a/DEVEL/lablgtkmathview/gMathView.mli
+++ b/DEVEL/lablgtkmathview/gMathView.mli
@@ -24,10 +24,15 @@
  * For details, send a mail to the authors.
  *)
 
+(** {1 Main interface to LablGtkMathView} *)
+
 exception ErrorLoadingFile of string
 exception ErrorWritingFile of string
 exception ErrorLoadingDOM
 
+(** {2 Standard classes} *)
+
+(** Signals emitted by GtkMathView widgets *)
 class math_view_signals :
   ([> `gtk | `mathview_gmetadom | `widget] as 'b) Gtk.obj ->
   object ('a)
@@ -48,6 +53,7 @@ class math_view_signals :
       callback:(unit -> unit) -> GtkSignal.id
   end
 
+(** GtkMathView core methods *)
 class math_view_skel :
   (Gtk_mathview.math_view Gtk.obj as 'a)->
   object
@@ -83,6 +89,7 @@ class math_view_skel :
     method unselect : Gdome.element -> unit
   end
 
+(** GtkMathView standard class *)
 class math_view :
   Gtk_mathview.math_view Gtk.obj ->
   object
@@ -90,6 +97,9 @@ class math_view :
     method connect : math_view_signals
   end
 
+(** {2 Constructors} *)
+
+(** math_view constructor *)
 val math_view :
   ?hadjustment:GData.adjustment ->
   ?vadjustment:GData.adjustment ->
@@ -99,7 +109,7 @@ val math_view :
   ?height:int ->
   ?packing:(GObj.widget -> unit) -> ?show:bool -> unit -> math_view
 
-(** {2 Global configuration for all math_view instances *)
+(** {2 Global configuration for all math_view instances} *)
 
   (** @param fname file name to be added to the list of configuration files read
    * at initialization time.
diff --git a/DEVEL/lablgtkmathview/gMathViewAux.mli b/DEVEL/lablgtkmathview/gMathViewAux.mli
index 299328733..9e47e419a 100644
--- a/DEVEL/lablgtkmathview/gMathViewAux.mli
+++ b/DEVEL/lablgtkmathview/gMathViewAux.mli
@@ -24,6 +24,11 @@
  * For details, send a mail to the authors.
  *)
 
+(** {1 Selection-enabled GtkMathView classes} *)
+
+(** {2 Single-selection} *)
+
+(** signals *)
 class single_selection_math_view_signals :
   ([> `gtk | `mathview_gmetadom | `widget] as 'b) Gtk.obj ->
   ((Gdome.element option -> unit) -> unit) ->
@@ -32,6 +37,7 @@ class single_selection_math_view_signals :
     method selection_changed : (Gdome.element_of_node option -> unit) -> unit
   end
 
+(** main class *)
 class single_selection_math_view :
   Gtk_mathview.math_view Gtk.obj ->
   object
@@ -42,6 +48,7 @@ class single_selection_math_view :
     method action_toggle : Gdome.element -> bool
   end
 
+(** single_selection_math_view constructor *)
 val single_selection_math_view :
   ?hadjustment:GData.adjustment ->
   ?vadjustment:GData.adjustment ->
@@ -54,6 +61,9 @@ val single_selection_math_view :
   unit ->
     single_selection_math_view
 
+(** {2 Multiple-selection} *)
+
+(** main class, extends single_selection_math_view *)
 class multi_selection_math_view :
   Gtk_mathview.math_view Gtk.obj ->
   object
@@ -64,6 +74,7 @@ class multi_selection_math_view :
     method get_selections : Gdome.element list
   end
 
+(** multi_selection_math_view constructor *)
 val multi_selection_math_view :
   ?hadjustment:GData.adjustment ->
   ?vadjustment:GData.adjustment ->
-- 
2.39.2