Folks,

I was using eina_counter_* and noticed a few glitches in the docs.
Nothing really big, but there's no hurt on fixing it.

Cheers,

Eduardo Felipe.
Index: eina/src/lib/eina_counter.c
===================================================================
--- eina/src/lib/eina_counter.c (revision 47092)
+++ eina/src/lib/eina_counter.c (working copy)
@@ -250,7 +250,9 @@
  *    test_malloc();
  *    eina_counter_stop(counter, 1);
  *
- *    eina_counter_dump(counter);
+ *    char* result = eina_counter_dump(counter);
+ *    printf("%s", result);
+ *    free(result);
  *
  *    eina_counter_free(counter);
  *    eina_shutdown();
@@ -268,8 +270,8 @@
  * The result should be something like that:
  *
  * @code
- * # specimen  experiment time starting time   ending time
- * 1   9794125 783816  10577941
+ * \# specimen    experiment time    starting time    ending time
+ * 1              9794125            783816           10577941
  * @endcode
  *
  * Note that the displayed time is in nanosecond.
@@ -415,8 +417,9 @@
  * @return A string with a summary of the test.
  * @param counter The counter.
  *
- * This function dump all the valid clocks of @p counter to the stream
- * @p out. If @p counter or @p out are @c NULL, the functions exits
+ * This function returns an malloc'd string containing the dump of 
+ * all the valid clocks of @p counter.
+ * If @p counter @c NULL, the functions exits
  * immediatly. Otherwise, the output is formattted like that:
  *
  * @code
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to