]> git.lyx.org Git - lyx.git/blobdiff - src/frontends/xforms/freebrowser.h
get rid of broken_header.h and some unneeded tests
[lyx.git] / src / frontends / xforms / freebrowser.h
index b59b7c45df703cf9f6f5e02328a1745b0b410f43..0e2389c22a7c4aca9bda8a3c5c86ffcb3563f8c4 100644 (file)
@@ -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"
 {
@@ -50,24 +52,27 @@ typedef struct fl_freebrowser_ {
 } 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 *);
+FL_EXPORT void
+fl_hide_freebrowser(FL_FREEBROWSER *);
 
 #if defined(__cplusplus)
 }
 #endif
 
-#endif
+#endif /* not FL_FREEBROWSER_H */