summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBowon Ryu <bowon.ryu@samsung.com>2017-10-23 13:40:27 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-10-23 13:40:27 +0900
commit3489f5ec36c5399feda040bbfbb80f8fcbbd8337 (patch)
tree9e08b6456ffb4fddc9a029195635b78b483d09d2
parent8e25467a656a5b789761c9d0abf7de41851b32d6 (diff)
eet: add missing documentation.
Summary: This adds missing doxgen documentation for eet. Test Plan: API Doxygen Revision Reviewers: cedric, jpeg, myoungwoon Differential Revision: https://phab.enlightenment.org/D5344
-rw-r--r--src/lib/eet/Eet.h70
1 files changed, 57 insertions, 13 deletions
diff --git a/src/lib/eet/Eet.h b/src/lib/eet/Eet.h
index 688e82906b..cf1afd9552 100644
--- a/src/lib/eet/Eet.h
+++ b/src/lib/eet/Eet.h
@@ -288,7 +288,7 @@ eet_shutdown(void);
288 288
289/** 289/**
290 * @ingroup Eet_Group 290 * @ingroup Eet_Group
291 * @Clears eet cache. 291 * @brief Clears eet cache.
292 * 292 *
293 * For a faster access to previously accessed data, Eet keeps an internal 293 * For a faster access to previously accessed data, Eet keeps an internal
294 * cache of files. These files will be freed automatically only when 294 * cache of files. These files will be freed automatically only when
@@ -959,7 +959,7 @@ eet_num_entries(Eet_File *ef);
959 959
960/** 960/**
961 * @ingroup Eet_File_Cipher_Group 961 * @ingroup Eet_File_Cipher_Group
962 * @brif Reads a specified entry from an eet file and return data using a cipher. 962 * @brief Reads a specified entry from an eet file and return data using a cipher.
963 * @param ef A valid eet file handle opened for reading. 963 * @param ef A valid eet file handle opened for reading.
964 * @param name Name of the entry. eg: "/base/file_i_want". 964 * @param name Name of the entry. eg: "/base/file_i_want".
965 * @param size_ret Number of bytes read from entry and returned. 965 * @param size_ret Number of bytes read from entry and returned.
@@ -1652,9 +1652,9 @@ eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef,
1652/** 1652/**
1653 * @ingroup Eet_File_Image_Cipher_Group 1653 * @ingroup Eet_File_Image_Cipher_Group
1654 * @brief Reads image data from the named key in the eet file using a cipher. 1654 * @brief Reads image data from the named key in the eet file using a cipher.
1655 * @param ef A valid eet file handle opened for reading. 1655 * @param data The encoded pixel data.
1656 * @param name Name of the entry. eg: "/base/file_i_want".
1657 * @param cipher_key The key to use as cipher. 1656 * @param cipher_key The key to use as cipher.
1657 * @param size The size, in bytes, of the encoded pixel data.
1658 * @param src_x The starting x coordinate from where to dump the stream. 1658 * @param src_x The starting x coordinate from where to dump the stream.
1659 * @param src_y The starting y coordinate from where to dump the stream. 1659 * @param src_y The starting y coordinate from where to dump the stream.
1660 * @param d A pointer to the pixel surface. 1660 * @param d A pointer to the pixel surface.
@@ -2035,7 +2035,7 @@ eet_identity_close(Eet_Key *key);
2035 2035
2036/** 2036/**
2037 * @ingroup Eet_Cipher_Group 2037 * @ingroup Eet_Cipher_Group
2038 * @breif Sets a key to sign a file. 2038 * @brief Sets a key to sign a file.
2039 * 2039 *
2040 * @param ef the file to set the identity. 2040 * @param ef the file to set the identity.
2041 * @param key the key handle to set as identity. 2041 * @param key the key handle to set as identity.
@@ -2327,7 +2327,7 @@ eet_identity_certificate_print(const unsigned char *certificate,
2327 * EET_DATA_DESCRIPTOR_ADD_BASIC(my_desc, some_struct, "sub.other_num", 2327 * EET_DATA_DESCRIPTOR_ADD_BASIC(my_desc, some_struct, "sub.other_num",
2328 * sub.other_num, EET_T_INT); 2328 * sub.other_num, EET_T_INT);
2329 * EET_DATA_DESCRIPTOR_ADD_BASIC(my_desc, some_struct, "sub.one_more", 2329 * EET_DATA_DESCRIPTOR_ADD_BASIC(my_desc, some_struct, "sub.one_more",
2330 * sub.one_more", EET_T_INT); 2330 * sub.one_more, EET_T_INT);
2331 * ... 2331 * ...
2332 * } 2332 * }
2333 * @endcode 2333 * @endcode
@@ -3083,6 +3083,8 @@ eet_data_descriptor_free(Eet_Data_Descriptor *edd);
3083/** 3083/**
3084 * @ingroup Eet_Data_Group 3084 * @ingroup Eet_Data_Group
3085 * @brief This function returns the name of a data descriptor. 3085 * @brief This function returns the name of a data descriptor.
3086 * @param edd The data descriptor to get name.
3087 * @return The name of the data descriptor.
3086 * 3088 *
3087 * @since 1.8.0 3089 * @since 1.8.0
3088 */ 3090 */
@@ -4469,10 +4471,11 @@ eet_node_var_array_new(const char *name,
4469 */ 4471 */
4470/** 4472/**
4471 * @ingroup Eet_Node_Group 4473 * @ingroup Eet_Node_Group
4472 * @brief Creates a new short node. 4474 * @brief Creates a new hash node.
4473 * @param name Name of the node. 4475 * @param name Name of the node.
4474 * @param s Short value. 4476 * @param key Key of the node.
4475 * @return A new short node. 4477 * @param node The node.
4478 * @return A new hash node.
4476 */ 4479 */
4477EAPI Eet_Node * 4480EAPI Eet_Node *
4478eet_node_hash_new(const char *name, 4481eet_node_hash_new(const char *name,
@@ -4496,10 +4499,10 @@ eet_node_struct_new(const char *name,
4496 */ 4499 */
4497/** 4500/**
4498 * @ingroup Eet_Node_Group 4501 * @ingroup Eet_Node_Group
4499 * @brief Creates a new short node. 4502 * @brief Creates a new struct child node.
4500 * @param name Name of the node. 4503 * @param parent The name of parent node.
4501 * @param s Short value. 4504 * @param child The child node.
4502 * @return A new short node. 4505 * @return A new struct child node.
4503 */ 4506 */
4504EAPI Eet_Node * 4507EAPI Eet_Node *
4505eet_node_struct_child_new(const char *parent, 4508eet_node_struct_child_new(const char *parent,
@@ -4537,6 +4540,9 @@ eet_node_parent_get(Eet_Node *node);
4537/** 4540/**
4538 * @ingroup Eet_Node_Group 4541 * @ingroup Eet_Node_Group
4539 * @brief Appends a "list" node TODO FIX ME. 4542 * @brief Appends a "list" node TODO FIX ME.
4543 * @param parent The parent node.
4544 * @param name The name of new node.
4545 * @param child The child node.
4540 */ 4546 */
4541EAPI void 4547EAPI void
4542eet_node_list_append(Eet_Node *parent, 4548eet_node_list_append(Eet_Node *parent,
@@ -4546,6 +4552,10 @@ eet_node_list_append(Eet_Node *parent,
4546/** 4552/**
4547 * TODO FIX ME 4553 * TODO FIX ME
4548 * @ingroup Eet_Node_Group 4554 * @ingroup Eet_Node_Group
4555 * @brief Appends a struct node.
4556 * @param parent The parent node.
4557 * @param name The name of new node.
4558 * @param child The child node.
4549 */ 4559 */
4550EAPI void 4560EAPI void
4551eet_node_struct_append(Eet_Node *parent, 4561eet_node_struct_append(Eet_Node *parent,
@@ -4555,6 +4565,11 @@ eet_node_struct_append(Eet_Node *parent,
4555/** 4565/**
4556 * TODO FIX ME 4566 * TODO FIX ME
4557 * @ingroup Eet_Node_Group 4567 * @ingroup Eet_Node_Group
4568 * @brief Adds a hash node.
4569 * @param parent The parent node.
4570 * @param name Name of the node.
4571 * @param key Key of the node.
4572 * @param child The child node.
4558 */ 4573 */
4559EAPI void 4574EAPI void
4560eet_node_hash_add(Eet_Node *parent, 4575eet_node_hash_add(Eet_Node *parent,
@@ -4565,6 +4580,12 @@ eet_node_hash_add(Eet_Node *parent,
4565/** 4580/**
4566 * TODO FIX ME 4581 * TODO FIX ME
4567 * @ingroup Eet_Node_Group 4582 * @ingroup Eet_Node_Group
4583 * @brief Dumps a node from an eet encoded data structure into ascii text.
4584 * @param n The node.
4585 * @param dumplevel The dump level.
4586 * @param dumpfunc dumpfunc The function to call passed a string when new
4587 * data is converted to text.
4588 * @param dumpdata The data to pass to the @p dumpfunc callback.
4568 */ 4589 */
4569EAPI void 4590EAPI void
4570eet_node_dump(Eet_Node *n, 4591eet_node_dump(Eet_Node *n,
@@ -4593,6 +4614,8 @@ eet_node_value_get(Eet_Node *node);
4593/** 4614/**
4594 * TODO FIX ME 4615 * TODO FIX ME
4595 * @ingroup Eet_Node_Group 4616 * @ingroup Eet_Node_Group
4617 * @brief Deletes the given node.
4618 * @param n The node.
4596 */ 4619 */
4597EAPI void 4620EAPI void
4598eet_node_del(Eet_Node *n); 4621eet_node_del(Eet_Node *n);
@@ -4600,6 +4623,10 @@ eet_node_del(Eet_Node *n);
4600/** 4623/**
4601 * TODO FIX ME 4624 * TODO FIX ME
4602 * @ingroup Eet_Node_Group 4625 * @ingroup Eet_Node_Group
4626 * @brief Encodes node data using a cipher.
4627 * @param node The node.
4628 * @param cipher_key The key to use as cipher.
4629 * @param size_ret Number of bytes read from entry and returned.
4603 */ 4630 */
4604EAPI void * 4631EAPI void *
4605eet_data_node_encode_cipher(Eet_Node *node, 4632eet_data_node_encode_cipher(Eet_Node *node,
@@ -4609,6 +4636,11 @@ eet_data_node_encode_cipher(Eet_Node *node,
4609/** 4636/**
4610 * TODO FIX ME 4637 * TODO FIX ME
4611 * @ingroup Eet_Node_Group 4638 * @ingroup Eet_Node_Group
4639 * @brief Decodes node data using a cipher.
4640 * @param data_in The pointer to the data to decode into a struct.
4641 * @param cipher_key The key to use as cipher.
4642 * @param size_in The size of the data pointed to in bytes.
4643 * @return The decoded node.
4612 */ 4644 */
4613EAPI Eet_Node * 4645EAPI Eet_Node *
4614eet_data_node_decode_cipher(const void *data_in, 4646eet_data_node_decode_cipher(const void *data_in,
@@ -4618,6 +4650,11 @@ eet_data_node_decode_cipher(const void *data_in,
4618/** 4650/**
4619 * TODO FIX ME 4651 * TODO FIX ME
4620 * @ingroup Eet_Node_Group 4652 * @ingroup Eet_Node_Group
4653 * @brief Reads a node data from an eet file and decodes it using a cipher.
4654 * @param ef The eet file handle to read from.
4655 * @param name The key the data is stored under in the eet file.
4656 * @param cipher_key The key to use as cipher.
4657 * @return A node to the decoded data structure.
4621 */ 4658 */
4622EAPI Eet_Node * 4659EAPI Eet_Node *
4623eet_data_node_read_cipher(Eet_File *ef, 4660eet_data_node_read_cipher(Eet_File *ef,
@@ -4627,6 +4664,13 @@ eet_data_node_read_cipher(Eet_File *ef,
4627/** 4664/**
4628 * TODO FIX ME 4665 * TODO FIX ME
4629 * @ingroup Eet_Node_Group 4666 * @ingroup Eet_Node_Group
4667 * @brief Writes node data to the named key in an eet file using a cipher.
4668 * @param ef The eet file handle to write to.
4669 * @param name The key to store the data under in the eet file.
4670 * @param cipher_key The key to use as cipher.
4671 * @param node The node.
4672 * @param compress Compression flags for storage.
4673 * @return bytes written on successful write, 0 on failure.
4630 */ 4674 */
4631EAPI int 4675EAPI int
4632eet_data_node_write_cipher(Eet_File *ef, 4676eet_data_node_write_cipher(Eet_File *ef,