Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_fb
Modified Files:
ecore_fb.c
Log Message:
Just some docs for Ecore_FB functions, some functions still left to doc.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_fb/ecore_fb.c,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- ecore_fb.c 15 Jul 2004 13:43:14 -0000 1.6
+++ ecore_fb.c 23 Aug 2004 22:59:00 -0000 1.7
@@ -375,9 +375,17 @@
};
/**
+ * @defgroup Ecore_FB_Library_Group Framebuffer Library Functions
+ *
+ * Functions used to set up and shut down the Ecore_Framebuffer functions.
+ */
+
+/**
* Sets up the Ecore_Fb library.
- * @param name device target name
- * @return @c 0 on failure, greater than @c 0 on success.
+ * @param name device target name
+ * @return @c 0 on failure. Otherwise, the number of times the library has
+ * been initialised without being shut down.
+ * @ingroup Ecore_FB_Library_Group
*/
int
ecore_fb_init(const char *name)
@@ -509,8 +517,9 @@
/**
* Shuts down the Ecore_Fb library.
- * @return @c 0 if the system was shut * down, or 1 if it still needs to
- * be shut down
+ * @return @c The number of times the system has been initialised without
+ * being shut down.
+ * @ingroup Ecore_FB_Library_Group
*/
int
ecore_fb_shutdown(void)
@@ -555,13 +564,20 @@
}
/**
+ * @defgroup Ecore_FB_Click_Group Framebuffer Double Click Functions
+ *
+ * Functions that deal with the double click time of the framebuffer.
+ */
+
+/**
* Sets the timeout for a double and triple clicks to be flagged.
*
* This sets the time between clicks before the double_click flag is
* set in a button down event. If 3 clicks occur within double this
* time, the triple_click flag is also set.
*
- * @param t The time in seconds
+ * @param t The time in seconds
+ * @ingroup Ecore_FB_Click_Group
*/
void
ecore_fb_double_click_time_set(double t)
@@ -576,6 +592,7 @@
* See @ref ecore_x_double_click_time_set for more information.
*
* @return The timeout for double clicks in seconds.
+ * @ingroup Ecore_FB_Click_Group
*/
double
ecore_fb_double_click_time_get(void)
@@ -596,12 +613,19 @@
}
/**
+ * @defgroup Ecore_FB_Calibrate_Group Framebuffer Calibration Functions
+ *
+ * Functions that calibrate the screen.
+ */
+
+/**
* Calibrates the touschreen using the given parameters.
- * @param xscale X scaling, where 256 = 1.0
- * @param xtrans X translation.
- * @param yscale Y scaling.
- * @param ytrans Y translation.
- * @param xyswap Swap X & Y flag.
+ * @param xscale X scaling, where 256 = 1.0
+ * @param xtrans X translation.
+ * @param yscale Y scaling.
+ * @param ytrans Y translation.
+ * @param xyswap Swap X & Y flag.
+ * @ingroup Ecore_FB_Calibrate_Group
*/
void
ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans,
int xyswap)
@@ -619,12 +643,13 @@
/**
* Retrieves the calibration parameters of the touchscreen.
- * @param xscale Pointer to an integer in which to store the X scaling.
- * Note that 256 = 1.0.
- * @param xtrans Pointer to an integer in which to store the X translation.
- * @param yscale Pointer to an integer in which to store the Y scaling.
- * @param ytrans Pointer to an integer in which to store the Y translation.
- * @param xyswap Pointer to an integer in which to store the Swap X & Y flag.
+ * @param xscale Pointer to an integer in which to store the X scaling.
+ * Note that 256 = 1.0.
+ * @param xtrans Pointer to an integer in which to store the X translation.
+ * @param yscale Pointer to an integer in which to store the Y scaling.
+ * @param ytrans Pointer to an integer in which to store the Y translation.
+ * @param xyswap Pointer to an integer in which to store the Swap X & Y flag.
+ * @ingroup Ecore_FB_Calibrate_Group
*/
void
ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int
*ytrans, int *xyswap)
@@ -641,8 +666,15 @@
}
/**
+ * @defgroup Ecore_FB_Backlight_Group Framebuffer Backlight Functions
+ *
+ * Functions that deal with the backlight of a framebuffer's screen.
+ */
+
+/**
* Turns on or off the backlight.
- * @param on @c 1 to turn the backlight on. @c 0 to turn it off.
+ * @param on @c 1 to turn the backlight on. @c 0 to turn it off.
+ * @ingroup Ecore_FB_Backlight_Group
*/
void
ecore_fb_backlight_set(int on)
@@ -657,7 +689,8 @@
/**
* Retrieves the backlight state.
- * @return Whether the backlight is on.
+ * @return Whether the backlight is on.
+ * @ingroup Ecore_FB_Backlight_Group
*/
int
ecore_fb_backlight_get(void)
@@ -671,8 +704,9 @@
/**
* Sets the backlight brightness.
- * @param br Brightness between 0.0 to 1.0, where 0.0 is darkest and 1.0
- * is brightest.
+ * @param br Brightness between 0.0 to 1.0, where 0.0 is darkest and 1.0
+ * is brightest.
+ * @ingroup Ecore_FB_Backlight_Group
*/
void
ecore_fb_backlight_brightness_set(double br)
@@ -690,8 +724,9 @@
/**
* Retrieves the backlight brightness.
- * @return The current backlight brigntess, where 0.0 is the darkest and
- * 1.0 is the brightest.
+ * @return The current backlight brigntess, where 0.0 is the darkest and
+ * 1.0 is the brightest.
+ * @ingroup Ecore_FB_Backlight_Group
*/
double
ecore_fb_backlight_brightness_get(void)
@@ -704,9 +739,16 @@
}
/**
- * To be documented.
+ * @defgroup Ecore_FB_LED_Group Framebuffer LED Functions
*
- * FIXME: To be fixed.
+ * Functions that deal with the light emitting diode connected to the
+ * current framebuffer.
+ */
+
+/**
+ * Sets whether the current framebuffer's LED to the given state.
+ * @param on @c 1 to indicate the LED should be on, @c 0 if it should be off.
+ * @ingroup Ecore_FB_LED_Group
*/
void
ecore_fb_led_set(int on)
@@ -720,9 +762,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Makes the LED of the current framebuffer blink.
+ * @param speed Number to give the speed on the blink.
+ * @ingroup Ecore_FB_LED_Group
+ * @todo Documentation: Work out what speed the units are in.
*/
void
ecore_fb_led_blink_set(double speed)
@@ -738,9 +781,15 @@
}
/**
- * To be documented.
+ * @defgroup Ecore_FB_Contrast_Group Framebuffer Contrast Functions
*
- * FIXME: To be fixed.
+ * Values that set and retrieve the contrast of a framebuffer screen.
+ */
+
+/**
+ * Sets the contrast used by the framebuffer screen.
+ * @param cr Value between 0 and 1 that gives the new contrast of the screen.
+ * @ingroup Ecore_FB_Contrast_Group
*/
void
ecore_fb_contrast_set(double cr)
@@ -756,9 +805,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves the contrast currently being used by the framebuffer screen.
+ * @return A value between 0 and 1 that represents the current contrast of the
+ * screen.
+ * @ingroup Ecore_FB_Contrast_Group
*/
double
ecore_fb_contrast_get(void)
@@ -791,6 +841,7 @@
* To be documented.
*
* FIXME: To be fixed.
+ * @todo Documentation: Find out what this does.
*/
void
ecore_fb_callback_gain_set(void (*func) (void *data), void *data)
@@ -803,6 +854,7 @@
* To be documented.
*
* FIXME: To be fixed.
+ * @todo Documentation: Find out what this does.
*/
void
ecore_fb_callback_lose_set(void (*func) (void *data), void *data)
-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
