Fix doc

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/efreet@56783 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/ChangeLog b/ChangeLog
index cc61e00..899ac5b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -42,3 +42,9 @@
 2011-02-05  Hannes Janetzek
 
         * Clear mem cache when closing eet file
+
+2011-02-06  Sebastian Dransfeld
+
+        * Fix doc for efreet_utils.{h,c},efreet_mime.c
+        * Add comment for all internal EAPI functions
+        * Remove doc for removed _efreet_log_domain_global

diff --git a/doc/head.html b/doc/head.html
index 5fa253e..f9be916 100644 (file)
--- a/doc/head.html
+++ b/doc/head.html
@@ -46,6 +46,7 @@
     <div class="menu-container">
         <div class="submenu">
             <ul class="current">
+                <li><a href="group__Efreet__Utils.html">Utils</a></li>
                 <li><a href="group__Efreet__Uri.html">URI</a></li>
                 <li><a href="group__Efreet__Trash.html">Trash</a></li>
                 <li><a href="group__Efreet__Mime.html">Mime Types</a></li>

diff --git a/src/lib/efreet.c b/src/lib/efreet.c
index 7b79264..514ef37 100644 (file)
--- a/src/lib/efreet.c
+++ b/src/lib/efreet.c
@@ -36,6 +36,9 @@ void *alloca (size_t);
 #include "efreet_private.h"
 #include "efreet_xml.h"
 
+/*
+ * Needs EAPI because of helper binaries
+ */
 EAPI int efreet_cache_update = 1;
 
 static int _efreet_init_count = 0;

diff --git a/src/lib/efreet_cache.c b/src/lib/efreet_cache.c
index e35e6ad..0940a75 100644 (file)
--- a/src/lib/efreet_cache.c
+++ b/src/lib/efreet_cache.c
@@ -685,6 +685,9 @@ efreet_cache_icon_theme_name_list(int *num)
     return keys;
 }
 
+/*
+ * Needs EAPI because of helper binaries
+ */
 EAPI void
 efreet_cache_array_string_free(Efreet_Cache_Array_String *array)
 {

diff --git a/src/lib/efreet_mime.c b/src/lib/efreet_mime.c
index 97a0775..2f326bb 100644 (file)
--- a/src/lib/efreet_mime.c
+++ b/src/lib/efreet_mime.c
@@ -406,6 +406,9 @@ efreet_mime_type_icon_get(const char *mime, const char *theme, unsigned int size
     return icon;
 }
 
+/**
+ * @brief Clear mime icons mapping cache
+ */
 EAPI void
 efreet_mime_type_cache_clear(void)
 {
@@ -417,6 +420,12 @@ efreet_mime_type_cache_clear(void)
     mime_icons = eina_hash_stringshared_new(EINA_FREE_CB(efreet_mime_icon_entry_head_free));
 }
 
+/**
+ * @brief Flush mime icons mapping cache
+ *
+ * Flush timeout is defined at compile time by
+ * EFREET_MIME_ICONS_FLUSH_TIMEOUT
+ */
 EAPI void
 efreet_mime_type_cache_flush(void)
 {

diff --git a/src/lib/efreet_private.h b/src/lib/efreet_private.h
index 805342b..a5be666 100644 (file)
--- a/src/lib/efreet_private.h
+++ b/src/lib/efreet_private.h
@@ -61,11 +61,6 @@
     (x) = NULL; \
 } while (0)
 
-/**
- * @def _efreet_log_domain_global
- * global log domain for efreet (see eina_log module)
- */
-
 #ifdef EFREET_DEFAULT_LOG_COLOR
 #undef EFREET_DEFAULT_LOG_COLOR
 #endif

diff --git a/src/lib/efreet_utils.c b/src/lib/efreet_utils.c
index deb0abb..c33f9ee 100644 (file)
--- a/src/lib/efreet_utils.c
+++ b/src/lib/efreet_utils.c
@@ -161,6 +161,14 @@ efreet_util_path_in_default(const char *section, const char *path)
     return ret;
 }
 
+/**
+ * Returns the fdo file id for a given path. If the file isn't inside
+ * a default fdo path it will return NULL.
+ *
+ * @param path The path to find the file id for
+ *
+ * @return File id for path or NULL
+ */
 EAPI const char *
 efreet_util_path_to_file_id(const char *path)
 {
@@ -688,6 +696,9 @@ efreet_util_desktop_cache_reload(void)
     cache = efreet_cache_close(cache);
 }
 
+/*
+ * Needs EAPI because of helper binaries
+ */
 EAPI void
 efreet_hash_free(Eina_Hash *hash, Eina_Free_Cb free_cb)
 {

diff --git a/src/lib/efreet_utils.h b/src/lib/efreet_utils.h
index bac7222..93b03e7 100644 (file)
--- a/src/lib/efreet_utils.h
+++ b/src/lib/efreet_utils.h
@@ -1,6 +1,15 @@
 #ifndef EFREET_UTILS_H
 #define EFREET_UTILS_H
 
+/**
+ * @file efreet_utils.h
+ * @brief Contains utility functions to ease usage of Efreet.
+ *        FDO desktop entry specificiation.
+ * @addtogroup Efreet_Utils Efreet utilities for FDO
+ *
+ * @{
+ */
+
 EAPI const char *efreet_util_path_to_file_id(const char *path);
 
 EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime);
@@ -21,4 +30,7 @@ EAPI Eina_List *efreet_util_desktop_category_list(const char *category);
 
 EAPI Eina_List *efreet_util_menus_find(void);
 
+/**
+ * @}
+ */
 #endif