Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_fb
Modified Files:
Tag: SPLIT
ecore_fb.c
Log Message:
spacing between api calls... in docs
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_fb/Attic/ecore_fb.c,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -3 -r1.1.2.8 -r1.1.2.9
--- ecore_fb.c 20 Feb 2003 06:56:40 -0000 1.1.2.8
+++ ecore_fb.c 27 Feb 2003 01:58:13 -0000 1.1.2.9
@@ -355,6 +355,14 @@
"0x7f"
};
+/**
+ * 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
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+ */
int
ecore_fb_init(const char *name)
{
@@ -452,6 +460,13 @@
return _ecore_fb_init_count;
}
+/**
+ * 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.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
+ */
int
ecore_fb_shutdown(void)
{
@@ -487,12 +502,13 @@
}
/**
- * Set the timeout for double/triple click to be flagged
+ * Set the timeout for double/triple click to be flagged.
* @param t The time in seconds
*
* 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.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_double_click_time_set(double t)
@@ -502,10 +518,11 @@
}
/**
- * Get the double/triple click timeout
+ * Get the double/triple click timeout.
* @return The timeout for double clicks in seconds
*
* This returns the tiemout that can be set by ecore_fb_double_click_time_set()
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
double
ecore_fb_double_click_time_get(void)
@@ -514,11 +531,12 @@
}
/**
- * Get the current fb width and height in pixels
- * @param w
- * @param h
+ * 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
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_size_get(int *w, int *h)
@@ -528,14 +546,15 @@
}
/**
- * Calibrate the touschreen
- * @param xscale
- * @param xtrans
- * @param yscale
- * @param ytrans
- * @param xyswap
+ * 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
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_touch_screen_calibrate_set(int xscale, int xtrans, int yscale, int ytrans,
int xyswap)
@@ -552,14 +571,15 @@
}
/**
- * Get calibratio og the touschreen
- * @param xscale
- * @param xtrans
- * @param yscale
- * @param ytrans
- * @param xyswap
+ * 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
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_touch_screen_calibrate_get(int *xscale, int *xtrans, int *yscale, int
*ytrans, int *xyswap)
@@ -576,10 +596,11 @@
}
/**
- * Set the backlight
- * @param on
+ * Set the backlight.
+ * @param on 1 or 0 corresponding to on or off
*
* Set the backlight to the @p on state
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_backlight_set(int on)
@@ -593,10 +614,11 @@
}
/**
- * Get the backlight state
+ * Get the backlight state.
* @return The current backlight state
*
* Get the current backlight state
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
ecore_fb_backlight_get(void)
@@ -609,11 +631,12 @@
}
/**
- * Set the backlight brightness
+ * 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.
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
ecore_fb_backlight_brightness_set(double br)
@@ -630,11 +653,12 @@
}
/**
- * Get the backlight brightness
+ * Get the backlight brightness.
* @return The current backlight brigntess
*
* Get the current backlight brightness as per
* ecore_fb_backlight_brightness_set().
+ * <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
double
ecore_fb_backlight_brightness_get(void)
-------------------------------------------------------
This SF.net email is sponsored by: Scholarships for Techies!
Can't afford IT training? All 2003 ictp students receive scholarships.
Get hands-on training in Microsoft, Cisco, Sun, Linux/UNIX, and more.
www.ictp.com/training/sourceforge.asp
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
