summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTae-Hwan Kim <the81.kim@samsung.com>2014-11-14 07:05:10 +0100
committerCedric BAIL <cedric@osg.samsung.com>2014-11-14 07:34:13 +0100
commita402d4138ac64000a4240fca733f2edd8f4b3e6c (patch)
tree32ced457d972c638938fee9dd70aca284ace4344
parent9e7b3dde4adaa31e19a2fd6750414764d10d4910 (diff)
eina: enhance doxygen in eina_counter.h
Summary: Add @details for detailed description Add @note for noted description Add [in] & [out] for parameters Fix indentation & Fix typeof Reviewers: raster, cedric Reviewed By: cedric Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D1651 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
-rw-r--r--src/lib/eina/eina_counter.h82
1 files changed, 41 insertions, 41 deletions
diff --git a/src/lib/eina/eina_counter.h b/src/lib/eina/eina_counter.h
index ad6a76415c..7c58ec1ec8 100644
--- a/src/lib/eina/eina_counter.h
+++ b/src/lib/eina/eina_counter.h
@@ -107,88 +107,88 @@
107 107
108/** 108/**
109 * @typedef Eina_Counter 109 * @typedef Eina_Counter
110 * @brief Type for Counter. 110 * @brief An opaque type for counter.
111 */ 111 */
112typedef struct _Eina_Counter Eina_Counter; 112typedef struct _Eina_Counter Eina_Counter;
113 113
114 114
115/** 115/**
116 * @brief Return a counter. 116 * @brief Returns a counter.
117 * 117 *
118 * @param name The name of the counter. 118 * @param[in] name The name of the counter
119 * @return A newly allocated counter. 119 * @return A newly allocated counter
120 * 120 *
121 * This function returns a new counter. It is characterized by @p 121 * @details This function returns a new counter. It is characterized by @p
122 * name. If @p name is @c NULL, the function returns @c NULL 122 * name. If @p name is @c NULL, the function returns @c NULL
123 * immediately. If memory allocation fails, @c NULL is returned. 123 * immediately. If memory allocation fails, @c NULL is returned.
124 * 124 *
125 * Whe the new counter is not needed anymore, use eina_counter_free() to 125 * @note Whe the new counter is not needed anymore, use eina_counter_free() to
126 * free the allocated memory. 126 * free the allocated memory.
127 */ 127 */
128EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); 128EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
129 129
130/** 130/**
131 * @brief Delete a counter. 131 * @brief Deletes a counter.
132 * 132 *
133 * @param counter The counter to delete. 133 * @param[in] counter The counter to delete
134 * 134 *
135 * This function remove the clock of @p counter from the used clocks 135 * @details This function removes the clock of @p counter from the used clocks
136 * (see eina_counter_start()) and frees the memory allocated for 136 * (see eina_counter_start()) and frees the memory allocated for
137 * @p counter. If @p counter is @c NULL, the function returns 137 * @p counter. If @p counter is @c NULL, the function returns
138 * immediately. 138 * immediately.
139 */ 139 */
140EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1); 140EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1);
141 141
142/** 142/**
143 * @brief Start the time count. 143 * @brief Starts the time count.
144 * 144 *
145 * @param counter The counter. 145 * @param[in] counter The counter
146 * 146 *
147 * This function specifies that the part of the code beginning just 147 * @details This function specifies that the part of the code beginning just
148 * after its call is being to be timed, using @p counter. If 148 * after its call is being timed, using @p counter. If
149 * @p counter is @c NULL, this function returns immediately. 149 * @p counter is @c NULL, this function returns immediately.
150 * 150 *
151 * This function adds the clock associated to @p counter in a list. If 151 * @note This function adds the clock associated to @p counter in a list. If
152 * the memory needed by that clock can not be allocated, the function 152 * the memory needed by that clock can not be allocated, the function
153 * returns and nothing is done. 153 * returns and nothing is done.
154 * 154 *
155 * To stop the timing, eina_counter_stop() must be called with the 155 * @note To stop the timing, eina_counter_stop() must be called with the
156 * same counter. 156 * same counter.
157 */ 157 */
158EAPI void eina_counter_start(Eina_Counter *counter) EINA_ARG_NONNULL(1); 158EAPI void eina_counter_start(Eina_Counter *counter) EINA_ARG_NONNULL(1);
159 159
160/** 160/**
161 * @brief Stop the time count. 161 * @brief Stops the time count.
162 * 162 *
163 * @param counter The counter. 163 * @param[in] counter The counter
164 * @param specimen The number of the test. 164 * @param[in] specimen The number of the test
165 * 165 *
166 * This function stop the timing that has been started with 166 * @details This function stops the timing that has been started with
167 * eina_counter_start(). @p counter must be the same than the one used 167 * eina_counter_start(). @p counter must be the same as the one used
168 * with eina_counter_start(). @p specimen is the number of the 168 * with eina_counter_start(). @p specimen is the number of the
169 * test. If @p counter or its associated clock are @c NULL, or if the 169 * test. If @p counter or its associated clock is @c NULL, or if the
170 * time can't be retrieved the function exits. 170 * time can't be retrieved the function exits.
171 */ 171 */
172EAPI void eina_counter_stop(Eina_Counter *counter, 172EAPI void eina_counter_stop(Eina_Counter *counter,
173 int specimen) EINA_ARG_NONNULL(1); 173 int specimen) EINA_ARG_NONNULL(1);
174 174
175/** 175/**
176 * @brief Dump the result of all clocks of a counter to a stream. 176 * @brief Dumps the result of all the clocks of a counter to a stream.
177 * 177 *
178 * @return A string with a summary of the test. 178 * @param[in] counter The counter
179 * @param counter The counter. 179 * @return A string with a summary of the test
180 * 180 *
181 * This function returns an malloc'd string containing the dump of 181 * @details This function returns an malloc'd string containing the dump of
182 * all the valid clocks of @p counter. 182 * all the valid clocks of @p counter.
183 * If @p counter @c NULL, the functions exits 183 * If @p counter is @c NULL, the functions exits
184 * immediately. Otherwise, the output is formattted like that: 184 * immediately. Otherwise, the output is formatted like this:
185 * 185 *
186 * @verbatim 186 * @verbatim
187 * \# specimen experiment time starting time ending time 187 * \# specimen experiment time starting time ending time
188 * 1 208 120000 120208 188 * 1 208 120000 120208
189 * @endverbatim 189 * @endverbatim
190 * 190 *
191 * The unit of time is the nanosecond. 191 * @note The unit of time is nanoseconds.
192 */ 192 */
193EAPI char *eina_counter_dump(Eina_Counter *counter) EINA_ARG_NONNULL(1); 193EAPI char *eina_counter_dump(Eina_Counter *counter) EINA_ARG_NONNULL(1);
194 194