cedric pushed a commit to branch master.

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

commit be9390ce8b0c13cc315cff3ffcf5888f7b387045
Author: Tae-Hwan Kim <the81....@samsung.com>
Date:   Mon Oct 27 09:06:16 2014 +0100

    eina: enhance doxygen for eina_counter.h
    
    Summary:
    Arrange grouping
    Add @brief for brief description
    Add @details for detailed description
    Add [in] & [out] for parameters
    Fix indentation & Fix typeof
    
    Reviewers: raster, cedric
    
    Subscribers: cedric
    
    Differential Revision: https://phab.enlightenment.org/D1579
    
    Signed-off-by: Cedric BAIL <ced...@osg.samsung.com>
---
 src/lib/eina/eina_counter.h | 33 ++++++++++-----------------------
 1 file changed, 10 insertions(+), 23 deletions(-)

diff --git a/src/lib/eina/eina_counter.h b/src/lib/eina/eina_counter.h
index 5d54e90..ad6a764 100644
--- a/src/lib/eina/eina_counter.h
+++ b/src/lib/eina/eina_counter.h
@@ -22,20 +22,21 @@
 #include "eina_types.h"
 
 /**
- * @addtogroup Eina_Counter_Group Counter
+ * @defgroup Eina_Counter_Group Counter
+ * @ingroup Eina_Tools_Group
  *
- * @brief These functions allow you to get the time spent in a part of a code.
+ * @brief This group discusses the functions that allow you to get the time 
spent in a part of a code.
  *
  * Before using the counter system, Eina must be initialized with
- * eina_init() and later shut down with eina_shutdown(). The create a
+ * eina_init() and later shut down with eina_shutdown(). To create a
  * counter, use eina_counter_new(). To free it, use
  * eina_counter_free().
  *
  * To time a part of a code, call eina_counter_start() just before it,
  * and eina_counter_stop() just after it. Each time you start to time
- * a code, a clock is added to a list. You can give a number of that
+ * a code, a clock is added to a list. You can give the number of that
  * clock with the second argument of eina_counter_stop(). To send all
- * the registered clocks to a stream (like stdout, ofr a file), use
+ * the registered clocks to a stream (like stdout, for a file), use
  * eina_counter_dump().
  *
  * Here is a straightforward example:
@@ -86,37 +87,27 @@
  * }
  * @endcode
  *
- * Compile this code with the following commant:
+ * Compile this code with the following command:
  *
  * @verbatim
  * gcc -Wall -o test_eina_counter test_eina.c `pkg-config --cflags --libs eina`
  * @endverbatim
  *
- * The result should be something like that:
+ * The result should be something like this:
  *
  * @verbatim
  * \# specimen    experiment time    starting time    ending time
  * 1              9794125            783816           10577941
  * @endverbatim
  *
- * @note The displayed time is in nanosecond.
- */
-
-/**
- * @addtogroup Eina_Tools_Group Tools
- *
- * @{
- */
-
-/**
- * @defgroup Eina_Counter_Group Counter
+ * @note The displayed time is in nanoseconds.
  *
  * @{
  */
 
 /**
  * @typedef Eina_Counter
- * Counter type.
+ * @brief Type for Counter.
  */
 typedef struct _Eina_Counter Eina_Counter;
 
@@ -205,8 +196,4 @@ EAPI char         *eina_counter_dump(Eina_Counter *counter) 
EINA_ARG_NONNULL(1);
  * @}
  */
 
-/**
- * @}
- */
-
 #endif /* EINA_COUNTER_H_ */

-- 


Reply via email to