* add ocamldoc comments to .mli interface files

[helm.git] / DEVEL / lablgtkmathview / gMathView.mli

diff --git a/DEVEL/lablgtkmathview/gMathView.mli b/DEVEL/lablgtkmathview/gMathView.mli
index d116c527d8f9077d2197999ae22b1094c69c44d0..08299209185e8f1da5aa8696fdc8fc11f0670c48 100644 (file)
--- 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.