Enlightenment CVS committal
Author : rbdpngn
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src
Modified Files:
ewl_floater.c ewl_floater.h
Log Message:
Docs for the floater widget.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_floater.c,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -3 -r1.10 -r1.11
--- ewl_floater.c 13 Jul 2003 05:52:49 -0000 1.10
+++ ewl_floater.c 1 Sep 2003 03:16:02 -0000 1.11
@@ -17,11 +17,11 @@
void *user_data);
/**
- * ewl_floater_new - allocate a new floater widget
- * @parent: the parent widget to follow if desired
+ * @param parent: the parent widget to follow if desired
+ * @return Returns NULL on failure, or the new floater widget on success.
+ * @brief Allocate a new floater widget
*
- * Returns NULL on failure, or a pointer to the newly allocated floater
- * widget on success. The @parent widget should be either a widget to follow
+ * The @a parent widget should be either a widget to follow
* relative too, or a window for absolute positioning.
*/
Ewl_Widget *ewl_floater_new(Ewl_Widget * parent)
@@ -44,12 +44,12 @@
/**
- * ewl_floater_init - initialize a floater to default values
- * @f: the floater widget
- * @parent: the parent widget, we need this to get the evas and clip_box
+ * @param f: the floater widget
+ * @param parent: the parent widget, we need this to get the evas and clip_box
+ * @return Returns no value.
+ * @brief Initialize a floater to default values
*
- * Returns no value. Sets the fields and callbacks of the floater @f to their
- * defaults.
+ * Sets the fields and callbacks of the floater @a f to their defaults.
*/
void ewl_floater_init(Ewl_Floater * f, Ewl_Widget * parent)
{
@@ -112,12 +112,11 @@
}
/**
- * ewl_floater_set_position - set the start x/y position of the floater
- * @f: Ewl_Floater * - the floater widget
- * @x: int - start x coordinate from the top
- * @y: int - start y coordinate from the top
- *
- * Returns no value
+ * @param f: Ewl_Floater * - the floater widget
+ * @param x: int - start x coordinate from the top
+ * @param y: int - start y coordinate from the top
+ * @return Returns no value
+ * @brief Set the start x/y position of the floater
*/
void ewl_floater_set_position(Ewl_Floater * f, int x, int y)
{
@@ -141,12 +140,13 @@
}
/**
- * ewl_floater_set_relative - set a floater positioned relative to a widget
- * @f: the floater to change positioning relation
- * @w: the widget to position the floater relative
+ * @param f: the floater to change positioning relation
+ * @param w: the widget to position the floater relative
+ * @return Returns no value.
+ * @brief Set a floater positioned relative to a widget
*
- * Returns no value. Sets the floater @f to be positioned relative to the
- * position of the widget @w.
+ * Sets the floater @a f to be positioned relative to the
+ * position of the widget @a w.
*/
void ewl_floater_set_relative(Ewl_Floater * f, Ewl_Widget * w)
{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_floater.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ewl_floater.h 25 May 2002 05:46:40 -0000 1.3
+++ ewl_floater.h 1 Sep 2003 03:16:02 -0000 1.4
@@ -1,23 +1,36 @@
-/*
- * The floater is a container for widgets that need to be drawn on top
- * of multiple widgets (f.eks dropdownbox)
- *
- */
-
#ifndef __EWL_FLOATER_H__
#define __EWL_FLOATER_H__
-typedef struct _ewl_floater Ewl_Floater;
+/**
+ * @file ewl_floater.h
+ * Defines a widget for layering above other widgets in EWL's drawing area,
+ * with the ability to follow the movement of another widget.
+ */
-#define EWL_FLOATER(floatwidget) ((Ewl_Floater *) floatwidget)
+/**
+ * The floater is a container for widgets that need to be drawn on top
+ * of multiple widgets (ie. dropdownbox)
+ */
+typedef struct Ewl_Floater Ewl_Floater;
+/**
+ * @def EWL_FLOATER(floater)
+ * Typecasts a pointer to an Ewl_Floater pointer.
+ */
+#define EWL_FLOATER(floater) ((Ewl_Floater *) floater)
-struct _ewl_floater {
- Ewl_Box box;
- Ewl_Widget *follows;
- int x;
- int y;
+/**
+ * @struct Ewl_Floater
+ * Inherits from Ewl_Box for layout purposes. Provides a means to layer above
+ * other widgets and to follow the movement of another widget.
+ */
+struct Ewl_Floater
+{
+ Ewl_Box box; /**< Inherit from Ewl_Box */
+ Ewl_Widget *follows; /**< The widget to position relative to */
+ int x; /**< The x offset from follows x positon */
+ int y; /**< The y offset from follows y positon */
};
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
