timer23
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

eeze/doc: Notes about init and shutdown of the sensor subsystem. 

Make both functions and EAPI as well. Not needed if the general eeze_init
is called though. Note that in the docs.

SVN revision: 80072
This commit is contained in:
Stefan Schmidt 2012-12-03 14:45:14 +00:00
parent 1f5820514e
commit a3269e66fe
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
legacy/eeze/src/lib/Eeze_Sensor.h
View File

@ -263,21 +263,25 @@ EAPI Eeze_Sensor_Obj *eeze_sensor_obj_get(Eeze_Sensor_Type type);
* @return EINA_TRUE for success and EINA_FALSE for failure * @return EINA_TRUE for success and EINA_FALSE for failure
* *
* This function must be called before using any of the Eeze_Sensor * This function must be called before using any of the Eeze_Sensor
* functionality to make sure the subsystem is setup correctly for usage. * functionality to make sure the subsystem is setup correctly for usage. If
* you already call #eeze_init in your program this is already been take care
* of and there is no need to call this to initialize this subsystem manually.
* *
* @since 1.8 * @since 1.8
*/ */
Eina_Bool eeze_sensor_init(void); EAPI Eina_Bool eeze_sensor_init(void);
/** /**
* @brief Clean up and shutdown the Eeze sensor subsystem. * @brief Clean up and shutdown the Eeze sensor subsystem.
* *
* This function must be called when now longer using Eeze_Sensor to allow the * This function must be called when now longer using Eeze_Sensor to allow the
* subsystem to shutdown cleanly. * subsystem to shutdown cleanly. If you already called #eeze_shutdown this is
* already been taken care of and there is no need to call this to shutdown this
* subsystem manually.
* *
* @since 1.8 * @since 1.8
*/ */
void eeze_sensor_shutdown(void); EAPI void eeze_sensor_shutdown(void);
#ifdef __cplusplus #ifdef __cplusplus
} }

4
legacy/eeze/src/lib/eeze_sensor.c
View File

@ -232,7 +232,7 @@ eeze_sensor_async_read(Eeze_Sensor_Obj *sens, void *user_data)
return EINA_FALSE; return EINA_FALSE;
} }
void EAPI void
eeze_sensor_shutdown(void) eeze_sensor_shutdown(void)
{ {
eeze_sensor_modules_unload(); eeze_sensor_modules_unload();
@ -244,7 +244,7 @@ eeze_sensor_shutdown(void)
eina_shutdown(); eina_shutdown();
} }
Eina_Bool EAPI Eina_Bool
eeze_sensor_init(void) eeze_sensor_init(void)
{ {
if (!eina_init()) return EINA_FALSE; if (!eina_init()) return EINA_FALSE;