X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Ffrontends%2Fxforms%2Ffreebrowser.h;h=0e2389c22a7c4aca9bda8a3c5c86ffcb3563f8c4;hb=37e82a546392d43f787826b85481a11f2a27af15;hp=69ef628d61a0c6d09d4924a88b1225721a4215c0;hpb=63420525764fc687def947171385c1379ac45c9c;p=lyx.git

diff --git a/src/frontends/xforms/freebrowser.h b/src/frontends/xforms/freebrowser.h
index 69ef628d61..0e2389c22a 100644
--- a/src/frontends/xforms/freebrowser.h
+++ b/src/frontends/xforms/freebrowser.h
@@ -5,7 +5,7 @@
  *
  * \author Angus Leeming
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  *
  * A freebrowser is a browser widget in its own form.
  * It is used for example to instantiate the drop-down list beneath a
@@ -15,6 +15,8 @@
 #ifndef FL_FREEBROWSER_H
 #define FL_FREEBROWSER_H
 
+#include "lyx_forms.h"
+
 #if defined(__cplusplus)
 extern "C"
 {
@@ -39,35 +41,38 @@ typedef struct fl_freebrowser_ {
     /** Is set only if want_printable is true. */
     char last_printable;
 
-    /** Details of the implementation. */
+    /** The "owner" of the freebrowser. Not used by the struct. */
     void * parent;
-    FL_FORM * form;
+    /** The browser itself. */
     FL_OBJECT * browser;
+
+    /** Details of the implementation. */
+    FL_FORM * form;
     Window save_window;
 } FL_FREEBROWSER;
 
 
-/** A function to create a freebrowser widget, "owned" by widget \param parent.
- */
-FL_EXPORT FL_FREEBROWSER * fl_create_freebrowser(void * parent);
+/** A function to create a freebrowser widget, "owned" by \c parent. */
+FL_EXPORT FL_FREEBROWSER *
+fl_create_freebrowser(void * parent);
 
-FL_EXPORT void fl_free_freebrowser(FL_FREEBROWSER *);
+/** Free all memory allocated to \param ptr and to its components. */
+FL_EXPORT void
+fl_free_freebrowser(FL_FREEBROWSER * ptr);
 
-/** \param abs_x, \param abs_y are the coordinates of the top left corner
+/** \c abs_x, \c abs_y are the coordinates of the top left corner
  *  of the browser relative to the top left hand corner of the _screen_.
- *  \param w, \param h are the browser dimensions.
+ *  \c w, \c h are the browser dimensions.
  */
-FL_EXPORT void fl_show_freebrowser(FL_FREEBROWSER *,
-				   FL_Coord abs_x, FL_Coord abs_y,
-				   FL_Coord w, FL_Coord h);
+FL_EXPORT void
+fl_show_freebrowser(FL_FREEBROWSER *,
+		    FL_Coord abs_x, FL_Coord abs_y, FL_Coord w, FL_Coord h);
 
-FL_EXPORT void fl_hide_freebrowser(FL_FREEBROWSER *);
-
-/** Return the browser itself. */
-FL_EXPORT FL_OBJECT * fl_get_freebrowser_browser(FL_FREEBROWSER *);
+FL_EXPORT void
+fl_hide_freebrowser(FL_FREEBROWSER *);
 
 #if defined(__cplusplus)
 }
 #endif
 
-#endif
+#endif /* not FL_FREEBROWSER_H */