From 57dbcaaaa2931c4fbf1f8053a80fd64db69c34a7 Mon Sep 17 00:00:00 2001
From: Carsten Haitzler <raster@rasterman.com>
Date: Thu, 7 Apr 2011 12:38:55 +0000
Subject: [PATCH] more doxy -> .h

SVN revision: 58434
---
 legacy/eina/src/include/eina_main.h | 70 +++++++++++++++++++++++++++++
 legacy/eina/src/lib/eina_main.c     | 63 --------------------------
 2 files changed, 70 insertions(+), 63 deletions(-)

diff --git a/legacy/eina/src/include/eina_main.h b/legacy/eina/src/include/eina_main.h
index db80042465..f7fdf609e2 100644
--- a/legacy/eina/src/include/eina_main.h
+++ b/legacy/eina/src/include/eina_main.h
@@ -21,6 +21,15 @@
 
 #include "eina_types.h"
 
+/**
+ * @addtogroup Eina_Main_Group Main
+ *
+ * @brief These functions provide general initialisation and shut down
+ * functions.
+ *
+ * @{
+ */
+
 /**
  * @addtogroup Eina_Core_Group Core
  *
@@ -59,9 +68,66 @@ typedef struct _Eina_Version
 
 EAPI extern Eina_Version *eina_version;
 
+/**
+ * @brief Initialize the Eina library.
+ *
+ * @return 1 or greater on success, 0 on error.
+ *
+ * This function sets up all the eina modules. It returns 0 on
+ * failure (that is, when one of the module fails to initialize),
+ * otherwise it returns the number of times it has already been
+ * called.
+ *
+ * When Eina is not used anymore, call eina_shutdown() to shut down
+ * the Eina library.
+ */
 EAPI int eina_init(void);
+
+/**
+ * @brief Shut down the Eina library.
+ *
+ * @return 0 when all the modules is completely shut down, 1 or
+ * greater otherwise.
+ *
+ * This function shuts down the Eina library. It returns 0 when it has
+ * been called the same number of times than eina_init(). In that case
+ * it shut down all the Eina modules.
+ *
+ * Once this function succeeds (that is, @c 0 is returned), you must
+ * not call any of the Eina function anymore. You must call
+ * eina_init() again to use the Eina functions again.
+ */
 EAPI int eina_shutdown(void);
+
+/**
+ * @brief Initialize the mutexes of the Eina library.
+ *
+ * @return 1 or greater on success, 0 on error.
+ *
+ * This function sets up all the mutexes in all eina modules. It returns 0 on
+ * failure (that is, when one of the module fails to initialize),
+ * otherwise it returns the number of times it has already been
+ * called.
+ *
+ * When the mutexes are not used anymore, call eina_threads_shutdown() to shut down
+ * the mutexes.
+ */
 EAPI int eina_threads_init(void);
+
+/**
+ * @brief Shut down mutexes in the Eina library.
+ *
+ * @return 0 when all mutexes are completely shut down, 1 or
+ * greater otherwise.
+ *
+ * This function shuts down the mutexes in the Eina library. It returns 0 when it has
+ * been called the same number of times than eina_threads_init(). In that case
+ * it shut down all the mutexes.
+ *
+ * Once this function succeeds (that is, @c 0 is returned), you must
+ * not call any of the Eina function in a thread anymore. You must call
+ * eina_threads_init() again to use the Eina functions in a thread again.
+ */
 EAPI int eina_threads_shutdown(void);
 
 /**
@@ -72,4 +138,8 @@ EAPI int eina_threads_shutdown(void);
  * @}
  */
 
+/**
+ * @}
+ */
+
 #endif /* EINA_MAIN_H_ */
diff --git a/legacy/eina/src/lib/eina_main.c b/legacy/eina/src/lib/eina_main.c
index 48ca32c861..5ced551d63 100644
--- a/legacy/eina/src/lib/eina_main.c
+++ b/legacy/eina/src/lib/eina_main.c
@@ -189,34 +189,12 @@ _eina_shutdown_from_desc(const struct eina_desc_setup *itr)
 *                                   API                                      *
 *============================================================================*/
 
-/**
- * @addtogroup Eina_Main_Group Main
- *
- * @brief These functions provide general initialisation and shut down
- * functions.
- *
- * @{
- */
-
 /**
  * @var eina_version
  * @brief Eina version (defined at configuration time)
  */
 EAPI Eina_Version *eina_version = &_version;
 
-/**
- * @brief Initialize the Eina library.
- *
- * @return 1 or greater on success, 0 on error.
- *
- * This function sets up all the eina modules. It returns 0 on
- * failure (that is, when one of the module fails to initialize),
- * otherwise it returns the number of times it has already been
- * called.
- *
- * When Eina is not used anymore, call eina_shutdown() to shut down
- * the Eina library.
- */
 EAPI int
 eina_init(void)
 {
@@ -255,20 +233,6 @@ eina_init(void)
    return 1;
 }
 
-/**
- * @brief Shut down the Eina library.
- *
- * @return 0 when all the modules is completely shut down, 1 or
- * greater otherwise.
- *
- * This function shuts down the Eina library. It returns 0 when it has
- * been called the same number of times than eina_init(). In that case
- * it shut down all the Eina modules.
- *
- * Once this function succeeds (that is, @c 0 is returned), you must
- * not call any of the Eina function anymore. You must call
- * eina_init() again to use the Eina functions again.
- */
 EAPI int
 eina_shutdown(void)
 {
@@ -280,19 +244,6 @@ eina_shutdown(void)
 }
 
 
-/**
- * @brief Initialize the mutexes of the Eina library.
- *
- * @return 1 or greater on success, 0 on error.
- *
- * This function sets up all the mutexes in all eina modules. It returns 0 on
- * failure (that is, when one of the module fails to initialize),
- * otherwise it returns the number of times it has already been
- * called.
- *
- * When the mutexes are not used anymore, call eina_threads_shutdown() to shut down
- * the mutexes.
- */
 EAPI int
 eina_threads_init(void)
 {
@@ -328,20 +279,6 @@ eina_threads_init(void)
 #endif
 }
 
-/**
- * @brief Shut down mutexes in the Eina library.
- *
- * @return 0 when all mutexes are completely shut down, 1 or
- * greater otherwise.
- *
- * This function shuts down the mutexes in the Eina library. It returns 0 when it has
- * been called the same number of times than eina_threads_init(). In that case
- * it shut down all the mutexes.
- *
- * Once this function succeeds (that is, @c 0 is returned), you must
- * not call any of the Eina function in a thread anymore. You must call
- * eina_threads_init() again to use the Eina functions in a thread again.
- */
 EAPI int
 eina_threads_shutdown(void)
 {