Enlightenment CVS committal
Author : rbdpngn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_fb
Modified Files:
ecore_fb.c
Log Message:
More documentation patches from Nicholas Curran.
Added a couple includes to fix builds on minimal systems.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_fb/ecore_fb.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ecore_fb.c 9 May 2004 08:06:18 -0000 1.5
+++ ecore_fb.c 15 Jul 2004 13:43:14 -0000 1.6
@@ -375,11 +375,9 @@
};
/**
- * Set up the ecore fb system.
- * @param name device target name
- * @return 0 on failure, or greter than 0 on success.
- *
- * This starts up the ecore fb system
+ * Sets up the Ecore_Fb library.
+ * @param name device target name
+ * @return @c 0 on failure, greater than @c 0 on success.
*/
int
ecore_fb_init(const char *name)
@@ -510,10 +508,9 @@
}
/**
- * Shut down the ecore fb system.
- * @return 0 if the system was shut down, or 1 if it still needs to be shut down
- *
- * This shuts down the ecore fb system.
+ * 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
*/
int
ecore_fb_shutdown(void)
@@ -558,12 +555,13 @@
}
/**
- * Set the timeout for double/triple click to be flagged.
- * @param t The time in seconds
+ * 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.
*
- * 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 then the
- * triple_click flag is also set.
+ * @param t The time in seconds
*/
void
ecore_fb_double_click_time_set(double t)
@@ -573,10 +571,11 @@
}
/**
- * Get the double/triple click timeout.
- * @return The timeout for double clicks in seconds
+ * Retrieves the double and triple click flag timeout.
+ *
+ * See @ref ecore_x_double_click_time_set for more information.
*
- * This returns the tiemout that can be set by ecore_fb_double_click_time_set()
+ * @return The timeout for double clicks in seconds.
*/
double
ecore_fb_double_click_time_get(void)
@@ -585,11 +584,9 @@
}
/**
- * Get the current fb width and height in pixels.
- * @param w Width in pixels
- * @param h Height in pixels
- *
- * Get the current fb width and height in pixels
+ * Retrieves the width and height of the current frame buffer in pixels.
+ * @param w Pointer to an integer in which to store the width.
+ * @param h Pointer to an interge in which to store the height.
*/
void
ecore_fb_size_get(int *w, int *h)
@@ -599,14 +596,12 @@
}
/**
- * Calibrate the touschreen.
- * @param xscale X scaling (256 = 1.0)
- * @param xtrans X translation
- * @param yscale Y scaling
- * @param ytrans Y translation
- * @param xyswap Swap X & Y flag
- *
- * Calibrate the touchscreen using the above params
+ * 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.
*/
void
ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans,
int xyswap)
@@ -623,14 +618,13 @@
}
/**
- * Get calibratio og the touschreen.
- * @param xscale X scaling (256 = 1.0)
- * @param xtrans X translation
- * @param yscale Y scaling
- * @param ytrans Y translation
- * @param xyswap Swap X & Y flag
- *
- * Get calibration of the touchscreen
+ * 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.
*/
void
ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int
*ytrans, int *xyswap)
@@ -647,10 +641,8 @@
}
/**
- * Set the backlight.
- * @param on 1 or 0 corresponding to on or off
- *
- * Set the backlight to the @p on state
+ * Turns on or off the backlight.
+ * @param on @c 1 to turn the backlight on. @c 0 to turn it off.
*/
void
ecore_fb_backlight_set(int on)
@@ -664,10 +656,8 @@
}
/**
- * Get the backlight state.
- * @return The current backlight state
- *
- * Get the current backlight state
+ * Retrieves the backlight state.
+ * @return Whether the backlight is on.
*/
int
ecore_fb_backlight_get(void)
@@ -680,11 +670,9 @@
}
/**
- * Set the backlight brightness.
- * @param br Brightness 0.0 to 1.0
- *
- * Set the backglith brightness to @p br, where 0 is darkest and 1.0 is
- * the brightest.
+ * Sets the backlight brightness.
+ * @param br Brightness between 0.0 to 1.0, where 0.0 is darkest and 1.0
+ * is brightest.
*/
void
ecore_fb_backlight_brightness_set(double br)
@@ -701,11 +689,9 @@
}
/**
- * Get the backlight brightness.
- * @return The current backlight brigntess
- *
- * Get the current backlight brightness as per
- * ecore_fb_backlight_brightness_set().
+ * Retrieves the backlight brightness.
+ * @return The current backlight brigntess, where 0.0 is the darkest and
+ * 1.0 is the brightest.
*/
double
ecore_fb_backlight_brightness_get(void)
-------------------------------------------------------
This SF.Net email is sponsored by BEA Weblogic Workshop
FREE Java Enterprise J2EE developer tools!
Get your free copy of BEA WebLogic Workshop 8.1 today.
http://ads.osdn.com/?ad_id=4721&alloc_id=10040&op=click
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
