summaryrefslogtreecommitdiff
path: root/src/lib/ethumb
diff options
context:
space:
mode:
authorPhilippe Caseiro <pcaseiro@cadoles.com>2014-10-20 12:17:09 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:30:51 +0200
commitde18cf3b8c93f87c2958bbb860e989dc2f6b2a11 (patch)
tree92b83ef9b36f0611f9375ba8cbde312da85f5125 /src/lib/ethumb
parentcf1db89a62b3e814e379187e2d8b4fd453efdf3d (diff)
ethumb: update API documentation.
- ethumb_generate - ethumb_exists - ethumb_dup - ethumb_cmp
Diffstat (limited to 'src/lib/ethumb')
-rw-r--r--src/lib/ethumb/Ethumb.h34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/lib/ethumb/Ethumb.h b/src/lib/ethumb/Ethumb.h
index 65e2a66ce5..5d1fb0c31c 100644
--- a/src/lib/ethumb/Ethumb.h
+++ b/src/lib/ethumb/Ethumb.h
@@ -524,11 +524,45 @@ EAPI void ethumb_file_get(const Ethumb *e, const char **path, const char **
524 */ 524 */
525EAPI void ethumb_file_free(Ethumb *e) EINA_ARG_NONNULL(1); 525EAPI void ethumb_file_free(Ethumb *e) EINA_ARG_NONNULL(1);
526 526
527/**
528 * @brief Generate the thumbnail.
529 *
530 * @param e handle of the current thumbnailer.
531 * @param finished_cb The callback function to run on opertaion end
532 * @param free_data The callback function to run on free data.
533 *
534 * @return EINA_TRUE on success and EINA_FALSE on failure
535 */
527EAPI Eina_Bool ethumb_generate(Ethumb *e, Ethumb_Generate_Cb finished_cb, const void *data, Eina_Free_Cb free_data) EINA_ARG_NONNULL(1, 2); 536EAPI Eina_Bool ethumb_generate(Ethumb *e, Ethumb_Generate_Cb finished_cb, const void *data, Eina_Free_Cb free_data) EINA_ARG_NONNULL(1, 2);
537
538/**
539 * @brief test if the thumbnailer exists
540 *
541 * @param e handle of the thumbnailer to test.
542 *
543 * @return EINA_TRUE if thumbnailer exists and EINA_FALSE otherwise.
544 */
528EAPI Eina_Bool ethumb_exists(Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 545EAPI Eina_Bool ethumb_exists(Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
529 546
547/**
548 * @brief Duplicate an thumbnailer
549 *
550 * @param e Handle of the thumbnailer to duplicate
551 *
552 * @return a new allocated copy of the thumbnailer.
553 */
530EAPI Ethumb *ethumb_dup(const Ethumb *e) EINA_ARG_NONNULL(1); 554EAPI Ethumb *ethumb_dup(const Ethumb *e) EINA_ARG_NONNULL(1);
555
556/**
557 * @brief Compare two thumbnailers.
558 *
559 * @param e1 First handle of thumbnailer to compare
560 * @param e2 Second handle of thumbnailer to compare
561 *
562 * @return EINA_TRUE if the thumbnailers are equal and EINA_FALSE otherwise
563 */
531EAPI Eina_Bool ethumb_cmp(const Ethumb *e1, const Ethumb *e2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT EINA_PURE; 564EAPI Eina_Bool ethumb_cmp(const Ethumb *e1, const Ethumb *e2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT EINA_PURE;
565
532EAPI int ethumb_hash(const void *key, int key_length) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; 566EAPI int ethumb_hash(const void *key, int key_length) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE;
533EAPI int ethumb_key_cmp(const void *key1, int key1_length, 567EAPI int ethumb_key_cmp(const void *key1, int key1_length,
534 const void *key2, int key2_length) EINA_ARG_NONNULL(1, 3) EINA_WARN_UNUSED_RESULT EINA_PURE; 568 const void *key2, int key2_length) EINA_ARG_NONNULL(1, 3) EINA_WARN_UNUSED_RESULT EINA_PURE;