cedric pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=11d62ac4f3c2606f6b784f542fb5a6791bab65dd

commit 11d62ac4f3c2606f6b784f542fb5a6791bab65dd
Author: Philippe Caseiro <pcase...@cadoles.com>
Date:   Fri Oct 17 16:32:17 2014 +0200

    edje_convert: updating function documentation.
---
 src/lib/edje/edje_convert.h | 46 ++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 43 insertions(+), 3 deletions(-)

diff --git a/src/lib/edje/edje_convert.h b/src/lib/edje/edje_convert.h
index fcc2781..4d0248a 100644
--- a/src/lib/edje/edje_convert.h
+++ b/src/lib/edje/edje_convert.h
@@ -131,13 +131,53 @@ struct _Old_Edje_Part_Description
    Eina_List *external_params; /* parameters for external objects */
 };
 
+/**
+ * Convert old edje files into new edje files
+ *
+ * @param file an Eet_File to write the new edje file
+ * @param oedf the old edje file
+ *
+ * @return An Edje_File pointer to the converted file
+ */
 Edje_File *_edje_file_convert(Eet_File *file, Old_Edje_File *oedf);
+
+/**
+ * Convert old edje part collection into the new edje file
+ *
+ * @param file an Eet_File to write the new edje file
+ * @param oedc The old edje part collection
+ *
+ * @return a new edje parte collection
+ */
 Edje_Part_Collection *_edje_collection_convert(Edje_File *file,
-                                              Old_Edje_Part_Collection *oedc);
+                                               Old_Edje_Part_Collection *oedc);
+
+/**
+ * Convert old edje part descripton into new format
+ *
+ * @param type The edje par description common type
+ * @param ce an edje collection directory entry
+ * @param the old edje part descripton
+ *
+ * @return a new edje part descripton common
+ */
 Edje_Part_Description_Common *_edje_description_convert(int type,
-                                                       
Edje_Part_Collection_Directory_Entry *ce,
-                                                       
Old_Edje_Part_Description *oed);
+                                                        
Edje_Part_Collection_Directory_Entry *ce,
+                                                        
Old_Edje_Part_Description *oed);
+
+/**
+ * Get the current edje file
+ *
+ * @return the current edje file
+ */
 const Edje_File *_edje_file_get(void);
+
+/**
+ * Set the current edje file
+ *
+ * @param edf the edje file to set
+ *
+ */
 void _edje_file_set(const Edje_File *edf);
 
 #endif

-- 


Reply via email to