Cleanup Doxygen Warnings - eina

Patch by: Thiago Thamada <tiba@profusion.mobi>

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

diff --git a/src/include/eina_inline_log.x b/src/include/eina_inline_log.x
index 53d8afb..7f44643 100644 (file)
--- a/src/include/eina_inline_log.x
+++ b/src/include/eina_inline_log.x
@@ -26,7 +26,9 @@
  */
 
 /**
- * Checks whenever the given level should be printed out.
+ * @brief Checks whenever the given level should be printed out.
+ *
+ * @param level The level to print
  *
  * This is useful to enable certain blocks of code just when given
  * level is to be used.
@@ -53,7 +55,10 @@ eina_log_level_check(int level)
 }
 
 /**
- * Checks whenever the given level should be printed out.
+ * @brief Checks whenever the given level should be printed out.
+ *
+ * @param domain The domain to check
+ * @param level The level to print
  *
  * This is useful to enable certain blocks of code just when given
  * level is to be used.

diff --git a/src/include/eina_lock.h b/src/include/eina_lock.h
index 16f4314..aedf5e3 100644 (file)
--- a/src/include/eina_lock.h
+++ b/src/include/eina_lock.h
@@ -56,34 +56,58 @@ typedef enum
 
 EAPI extern Eina_Error EINA_ERROR_NOT_MAIN_LOOP;
 
+/** @relates static Eina_Bool eina_lock_new(_Eina_Lock *mutex) */
 static inline Eina_Bool eina_lock_new(Eina_Lock *mutex);
+/** @relates static void eina_lock_free(_Eina_Lock *mutex) */
 static inline void eina_lock_free(Eina_Lock *mutex);
+/** @relates static Eina_Lock_Result eina_lock_take(_Eina_Lock *mutex) */
 static inline Eina_Lock_Result eina_lock_take(Eina_Lock *mutex);
+/** @relates static Eina_Lock_Result eina_lock_take_try(_Eina_Lock *mutex) */
 static inline Eina_Lock_Result eina_lock_take_try(Eina_Lock *mutex);
+/** @relates static Eina_Lock_Result eina_lock_release(_Eina_Lock *mutex) */
 static inline Eina_Lock_Result eina_lock_release(Eina_Lock *mutex);
+/** @relates static void eina_lock_debug(const _Eina_Lock *mutex) */
 static inline void eina_lock_debug(const Eina_Lock *mutex);
 
+/** @relates static Eina_Bool eina_condition_new(_Eina_Condition *cond, _Eina_Lock *mutex) */
 static inline Eina_Bool eina_condition_new(Eina_Condition *cond, Eina_Lock *mutex);
+/** @relates static void eina_condition_free(_Eina_Condition *cond) */
 static inline void eina_condition_free(Eina_Condition *cond);
+/** @relates static Eina_Bool eina_condition_wait(_Eina_Condition *cond) */
 static inline Eina_Bool eina_condition_wait(Eina_Condition *cond);
+/** @relates static Eina_Bool eina_condition_timedwait(_Eina_Condition *cond, double t) */
 static inline Eina_Bool eina_condition_timedwait(Eina_Condition *cond, double t);
+/** @relates static Eina_Bool eina_condition_broadcast(_Eina_Condition *cond) */
 static inline Eina_Bool eina_condition_broadcast(Eina_Condition *cond);
+/** @relates static Eina_Bool eina_condition_signal(_Eina_Condition *cond) */
 static inline Eina_Bool eina_condition_signal(Eina_Condition *cond);
 
+/** @relates static Eina_Bool eina_rwlock_new(_Eina_RWLock *mutex) */
 static inline Eina_Bool eina_rwlock_new(Eina_RWLock *mutex);
+/** @relates static void eina_rwlock_free(_Eina_RWLock *mutex) */
 static inline void eina_rwlock_free(Eina_RWLock *mutex);
+/** @relates static Eina_Lock_Result eina_rwlock_take_read(_Eina_RWLock *mutex) */
 static inline Eina_Lock_Result eina_rwlock_take_read(Eina_RWLock *mutex);
+/** @relates static Eina_Lock_Result eina_rwlock_take_write(_Eina_RWLock *mutex) */
 static inline Eina_Lock_Result eina_rwlock_take_write(Eina_RWLock *mutex);
+/** @relates static Eina_Lock_Result eina_rwlock_release(_Eina_RWLock *mutex) */
 static inline Eina_Lock_Result eina_rwlock_release(Eina_RWLock *mutex);
 
+/** @relates static Eina_Bool eina_tls_new(pthread_key_t *key) */
 static inline Eina_Bool eina_tls_new(Eina_TLS *key);
+/** @relates static void eina_tls_free(pthread_key_t key) */
 static inline void eina_tls_free(Eina_TLS key);
+/** @relates static void eina_tls_get(pthread_key_t key) */
 static inline void *eina_tls_get(Eina_TLS key);
+/** @relates static Eina_Bool eina_tls_set(pthread_key_t key, const void *data) */
 static inline Eina_Bool eina_tls_set(Eina_TLS key, const void *data);
-
+/** @relates static Eina_Bool eina_semaphore_new(sem_t *sem, int count_init) */
 static inline Eina_Bool eina_semaphore_new(Eina_Semaphore *sem, int count_init);
+/** @relates static Eina_Bool eina_semaphore_free(sem_t *sem) */
 static inline Eina_Bool eina_semaphore_free(Eina_Semaphore *sem);
+/** @relates static Eina_Bool eina_semaphore_lock(sem_t *sem) */
 static inline Eina_Bool eina_semaphore_lock(Eina_Semaphore *sem);
+/** @relates static Eina_Bool eina_semaphore_release(sem_t *sem, int count_release) */
 static inline Eina_Bool eina_semaphore_release(Eina_Semaphore *sem, int count_release);
 
 #ifdef EINA_HAVE_DEBUG_THREADS

diff --git a/src/include/eina_unicode.h b/src/include/eina_unicode.h
index 2bbfe45..e9ac0c7 100644 (file)
--- a/src/include/eina_unicode.h
+++ b/src/include/eina_unicode.h
@@ -109,6 +109,9 @@ EAPI Eina_Unicode *eina_unicode_strncpy(Eina_Unicode *dest, const Eina_Unicode *
 
 /**
  * @see eina_str_escape()
+ *
+ * @param str The string to escape.
+ * @return The escaped string.
  */
 EAPI Eina_Unicode *eina_unicode_escape(const Eina_Unicode *str) EINA_ARG_NONNULL(1) EINA_MALLOC EINA_WARN_UNUSED_RESULT;