summaryrefslogtreecommitdiff
path: root/src/lib/elocation
diff options
context:
space:
mode:
authorStefan Schmidt <s.schmidt@samsung.com>2014-10-28 16:11:23 +0100
committerStefan Schmidt <s.schmidt@samsung.com>2014-11-11 11:08:58 +0100
commit701502cde20c695a135ac385478ed2e9e58023cc (patch)
tree7782ada42ffee2f8fac6abe8e08df40c3e7fa3b0 /src/lib/elocation
parent8468b8c073f726d62109b6ff885b80b757eefac9 (diff)
doc/elocation: Update since tag to an appropriate 1.13
Diffstat (limited to 'src/lib/elocation')
-rw-r--r--src/lib/elocation/Elocation.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/src/lib/elocation/Elocation.h b/src/lib/elocation/Elocation.h
index 851b679172..8db18a9b6b 100644
--- a/src/lib/elocation/Elocation.h
+++ b/src/lib/elocation/Elocation.h
@@ -72,7 +72,7 @@
72/** 72/**
73 * @ingroup Location 73 * @ingroup Location
74 * @brief Available location events that are emitted from the library 74 * @brief Available location events that are emitted from the library
75 * @since 1.8 75 * @since 1.13
76 * 76 *
77 * Ecore events emitted by the library. Applications can register ecore event 77 * Ecore events emitted by the library. Applications can register ecore event
78 * handlers to react on such events. After the initial query this can be used 78 * handlers to react on such events. After the initial query this can be used
@@ -94,7 +94,7 @@ EAPI extern int ELOCATION_EVENT_META_READY; /**< Meta provider is ready to be us
94/** 94/**
95 * @ingroup Location 95 * @ingroup Location
96 * @typedef Elocation_Accuracy_Level 96 * @typedef Elocation_Accuracy_Level
97 * @since 1.8 97 * @since 1.13
98 * 98 *
99 * Different location accuracy levels from country level up to detailed, 99 * Different location accuracy levels from country level up to detailed,
100 * e.g. GPS, information. 100 * e.g. GPS, information.
@@ -114,7 +114,7 @@ typedef enum {
114/** 114/**
115 * @ingroup Location 115 * @ingroup Location
116 * @typedef Elocation_Resource_Flags 116 * @typedef Elocation_Resource_Flags
117 * @since 1.8 117 * @since 1.13
118 * 118 *
119 * Flags for available system resources to be used for locating. So far they 119 * Flags for available system resources to be used for locating. So far they
120 * cover physical resources like network connection, cellular network 120 * cover physical resources like network connection, cellular network
@@ -134,7 +134,7 @@ typedef enum {
134/** 134/**
135 * @ingroup Location 135 * @ingroup Location
136 * @typedef Elocation_Accuracy 136 * @typedef Elocation_Accuracy
137 * @since 1.8 137 * @since 1.13
138 * 138 *
139 * Information about the accuracy of the reported location. For details about 139 * Information about the accuracy of the reported location. For details about
140 * the level of accuracy see #Elocation_Accuracy_Level. It also covers 140 * the level of accuracy see #Elocation_Accuracy_Level. It also covers
@@ -151,7 +151,7 @@ typedef struct _Elocation_Accuracy
151/** 151/**
152 * @ingroup Location 152 * @ingroup Location
153 * @typedef Elocation_Address 153 * @typedef Elocation_Address
154 * @since 1.8 154 * @since 1.13
155 * 155 *
156 * Location information in textual form. Depending on the used provider this 156 * Location information in textual form. Depending on the used provider this
157 * can cover only the country or a detailed address with postcode and street. 157 * can cover only the country or a detailed address with postcode and street.
@@ -173,7 +173,7 @@ typedef struct _Elocation_Address
173/** 173/**
174 * @ingroup Location 174 * @ingroup Location
175 * @typedef Elocation_Position 175 * @typedef Elocation_Position
176 * @since 1.8 176 * @since 1.13
177 * 177 *
178 * Location information based on the GPS grid. Latitude, longitude and altitude. 178 * Location information based on the GPS grid. Latitude, longitude and altitude.
179 * A timestamp is available to calculate the age of the address data. 179 * A timestamp is available to calculate the age of the address data.
@@ -190,7 +190,7 @@ typedef struct _Elocation_Postion
190/** 190/**
191 * @ingroup Location 191 * @ingroup Location
192 * @typedef Elocation_Velocity 192 * @typedef Elocation_Velocity
193 * @since 1.8 193 * @since 1.13
194 * 194 *
195 * Velocity information. So far this interface is only offered with GPS based 195 * Velocity information. So far this interface is only offered with GPS based
196 * providers. It offers information about speed, direction and climb. 196 * providers. It offers information about speed, direction and climb.
@@ -209,7 +209,7 @@ typedef struct _Elocation_Velocity
209/** 209/**
210 * @ingroup Location 210 * @ingroup Location
211 * @typedef Elocation_Requirements 211 * @typedef Elocation_Requirements
212 * @since 1.8 212 * @since 1.13
213 * 213 *
214 * Requirement settings for the location provider. Requirements can be a level 214 * Requirement settings for the location provider. Requirements can be a level
215 * of accuracy or allowed resources like network access or GPS. See 215 * of accuracy or allowed resources like network access or GPS. See
@@ -235,7 +235,7 @@ typedef struct _Elocation_Requirements
235 * with a call to #elocation_address_free. 235 * with a call to #elocation_address_free.
236 * 236 *
237 * @ingroup Location 237 * @ingroup Location
238 * @since 1.8 238 * @since 1.13
239 */ 239 */
240EAPI Elocation_Address *elocation_address_new(void); 240EAPI Elocation_Address *elocation_address_new(void);
241 241
@@ -248,7 +248,7 @@ EAPI Elocation_Address *elocation_address_new(void);
248 * no longer needed. 248 * no longer needed.
249 * 249 *
250 * @ingroup Location 250 * @ingroup Location
251 * @since 1.8 251 * @since 1.13
252 */ 252 */
253EAPI void elocation_address_free(Elocation_Address *address); 253EAPI void elocation_address_free(Elocation_Address *address);
254 254
@@ -261,7 +261,7 @@ EAPI void elocation_address_free(Elocation_Address *address);
261 * with a call to #elocation_address_free. 261 * with a call to #elocation_address_free.
262 * 262 *
263 * @ingroup Location 263 * @ingroup Location
264 * @since 1.8 264 * @since 1.13
265 */ 265 */
266EAPI Elocation_Position *elocation_position_new(void); 266EAPI Elocation_Position *elocation_position_new(void);
267 267
@@ -274,7 +274,7 @@ EAPI Elocation_Position *elocation_position_new(void);
274 * no longer needed. 274 * no longer needed.
275 * 275 *
276 * @ingroup Location 276 * @ingroup Location
277 * @since 1.8 277 * @since 1.13
278 */ 278 */
279EAPI void elocation_position_free(Elocation_Position *position); 279EAPI void elocation_position_free(Elocation_Position *position);
280 280
@@ -290,7 +290,7 @@ EAPI void elocation_position_free(Elocation_Position *position);
290 * event. 290 * event.
291 * 291 *
292 * @ingroup Location 292 * @ingroup Location
293 * @since 1.8 293 * @since 1.13
294 */ 294 */
295EAPI Eina_Bool elocation_address_get(Elocation_Address *address); 295EAPI Eina_Bool elocation_address_get(Elocation_Address *address);
296 296
@@ -306,7 +306,7 @@ EAPI Eina_Bool elocation_address_get(Elocation_Address *address);
306 * event. 306 * event.
307 * 307 *
308 * @ingroup Location 308 * @ingroup Location
309 * @since 1.8 309 * @since 1.13
310 */ 310 */
311EAPI Eina_Bool elocation_position_get(Elocation_Position *position); 311EAPI Eina_Bool elocation_position_get(Elocation_Position *position);
312 312
@@ -316,7 +316,7 @@ EAPI Eina_Bool elocation_position_get(Elocation_Position *position);
316 * @return EINA_TRUE for success and EINA_FALSE for failure. 316 * @return EINA_TRUE for success and EINA_FALSE for failure.
317 * 317 *
318 * @ingroup Location 318 * @ingroup Location
319 * @since 1.8 319 * @since 1.13
320 */ 320 */
321EAPI Eina_Bool elocation_status_get(int *status); 321EAPI Eina_Bool elocation_status_get(int *status);
322 322
@@ -328,7 +328,7 @@ EAPI Eina_Bool elocation_status_get(int *status);
328 * Set the requirements for selecting a provider. 328 * Set the requirements for selecting a provider.
329 * 329 *
330 * @ingroup Location 330 * @ingroup Location
331 * @since 1.8 331 * @since 1.13
332 */ 332 */
333EAPI Eina_Bool elocation_requirements_set(Elocation_Requirements *requirements); 333EAPI Eina_Bool elocation_requirements_set(Elocation_Requirements *requirements);
334 334
@@ -342,7 +342,7 @@ EAPI Eina_Bool elocation_requirements_set(Elocation_Requirements *requirements);
342 * representation of a location to a representation in textual form. 342 * representation of a location to a representation in textual form.
343 * 343 *
344 * @ingroup Location 344 * @ingroup Location
345 * @since 1.8 345 * @since 1.13
346 */ 346 */
347EAPI Eina_Bool elocation_position_to_address(Elocation_Position *position_shadow, Elocation_Address *address_shadow); 347EAPI Eina_Bool elocation_position_to_address(Elocation_Position *position_shadow, Elocation_Address *address_shadow);
348 348
@@ -356,7 +356,7 @@ EAPI Eina_Bool elocation_position_to_address(Elocation_Position *position_shadow
356 * representation of a location to a representation as GPS coordinates. 356 * representation of a location to a representation as GPS coordinates.
357 * 357 *
358 * @ingroup Location 358 * @ingroup Location
359 * @since 1.8 359 * @since 1.13
360 */ 360 */
361EAPI Eina_Bool elocation_address_to_position(Elocation_Address *address_shadow, Elocation_Position *position_shadow); 361EAPI Eina_Bool elocation_address_to_position(Elocation_Address *address_shadow, Elocation_Position *position_shadow);
362 362
@@ -375,7 +375,7 @@ EAPI Eina_Bool elocation_address_to_position(Elocation_Address *address_shadow,
375 * prone regarding correct results. 375 * prone regarding correct results.
376 * 376 *
377 * @ingroup Location 377 * @ingroup Location
378 * @since 1.8 378 * @since 1.13
379 */ 379 */
380EAPI Eina_Bool elocation_freeform_address_to_position(const char *freeform_address, Elocation_Position *position_shadow); 380EAPI Eina_Bool elocation_freeform_address_to_position(const char *freeform_address, Elocation_Position *position_shadow);
381 381
@@ -389,7 +389,7 @@ EAPI Eina_Bool elocation_freeform_address_to_position(const char *freeform_addre
389 * GeoClue. 389 * GeoClue.
390 * 390 *
391 * @ingroup Location 391 * @ingroup Location
392 * @since 1.8 392 * @since 1.13
393 */ 393 */
394EAPI Eina_Bool elocation_landmarks_get(Elocation_Position *position_shadow, Elocation_Address *address_shadow); 394EAPI Eina_Bool elocation_landmarks_get(Elocation_Position *position_shadow, Elocation_Address *address_shadow);
395 395
@@ -401,7 +401,7 @@ EAPI Eina_Bool elocation_landmarks_get(Elocation_Position *position_shadow, Eloc
401 * in your application to make sure it it setup correctly for usage. 401 * in your application to make sure it it setup correctly for usage.
402 * 402 *
403 * @ingroup Location 403 * @ingroup Location
404 * @since 1.8 404 * @since 1.13
405 */ 405 */
406EAPI Eina_Bool elocation_init(void); 406EAPI Eina_Bool elocation_init(void);
407 407
@@ -412,7 +412,7 @@ EAPI Eina_Bool elocation_init(void);
412 * the Elocation functionality to allow the subsystem to shutdown cleanly. 412 * the Elocation functionality to allow the subsystem to shutdown cleanly.
413 * 413 *
414 * @ingroup Location 414 * @ingroup Location
415 * @since 1.8 415 * @since 1.13
416 */ 416 */
417EAPI void elocation_shutdown(void); 417EAPI void elocation_shutdown(void);
418#endif 418#endif