Fix API reference header issues 75/243675/1 accepted/tizen/unified/20200910.123954 submit/tizen/20200909.054524
authorSeungha Son <seungha.son@samsung.com>
Wed, 9 Sep 2020 05:30:18 +0000 (14:30 +0900)
committerSeungha Son <seungha.son@samsung.com>
Wed, 9 Sep 2020 05:30:18 +0000 (14:30 +0900)
 - Create a link in documentation
 - Add '.' at the end of @brief
 - Add 'void' keyword inside parentheses

Change-Id: Ib92a3a3305a792d6c40ab127815766d838579b46
Signed-off-by: Seungha Son <seungha.son@samsung.com>
include/trace.h
src/trace.c

index fc9974d3c8e56bdde27c2ee13a6698dc6754044a..11a8f76cd17286a314bbd2f0d2e78bb7061c2016 100755 (executable)
@@ -50,8 +50,8 @@ typedef enum {
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
  * @param[in] name The name of event (optionally containing format specifiers)
- * @exception TRACE_ERROR_NONE Success
- * @exception TRACE_ERROR_IO_ERROR     I/O error
+ * @exception #TRACE_ERROR_NONE        Success
+ * @exception #TRACE_ERROR_IO_ERROR    I/O error
  * @see trace_end()
  */
 void trace_begin(const char *name, ...);
@@ -62,11 +62,11 @@ void trace_begin(const char *name, ...);
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  * @remarks trace_end() ends the most recently called trace_begin().
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
- * @exception TRACE_ERROR_NONE  Success
- * @exception TRACE_ERROR_IO_ERROR      I/O error
+ * @exception #TRACE_ERROR_NONE  Success
+ * @exception #TRACE_ERROR_IO_ERROR      I/O error
  * @see trace_begin()
  */
-void trace_end();
+void trace_end(void);
 
 /**
  * @brief Writes a trace event to indicate that an asynchronous event has begun.
@@ -75,8 +75,8 @@ void trace_end();
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
  * @param[in] cookie An unique identifier for distinguishing simultaneous events
  * @param[in] name The name of event (optionally containing format specifiers)
- * @exception TRACE_ERROR_NONE Success
- * @exception TRACE_ERROR_IO_ERROR     I/O error
+ * @exception #TRACE_ERROR_NONE        Success
+ * @exception #TRACE_ERROR_IO_ERROR    I/O error
  * @see trace_async_end()
  */
 void trace_async_begin(int cookie, const char *name, ...);
@@ -89,21 +89,21 @@ void trace_async_begin(int cookie, const char *name, ...);
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
  * @param[in] cookie An unique identifier for distinguishing simultaneous events
  * @param[in] name The name of event (optionally containing format specifiers)
- * @exception TRACE_ERROR_NONE  Success
- * @exception TRACE_ERROR_IO_ERROR      I/O error
+ * @exception #TRACE_ERROR_NONE  Success
+ * @exception #TRACE_ERROR_IO_ERROR      I/O error
  * @see trace_async_begin()
  */
 void trace_async_end(int cookie, const char *name, ...);
 
 /**
- * @brief Writes a trace event to track change of integer counter
+ * @brief Writes a trace event to track change of integer counter.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
  * @param[in] value The counter value
  * @param[in] name The name of event (optionally containing format specifiers)
- * @exception TRACE_ERROR_NONE  Success
- * @exception TRACE_ERROR_IO_ERROR      I/O error
+ * @exception #TRACE_ERROR_NONE  Success
+ * @exception #TRACE_ERROR_IO_ERROR      I/O error
  */
 void trace_update_counter(int value, const char *name, ...);
 
index a4f8fcd2e44088995e43f0a18a56dceb9dbcad1d..6ad2c096e9dd873091c9aaf36702183065c9ef6d 100755 (executable)
@@ -42,7 +42,7 @@ void trace_begin(const char *name, ...)
        va_end(ap);
 }
 
-void trace_end()
+void trace_end(void)
 {
        traceEnd(TTRACE_TAG_APP);
 }
@@ -86,7 +86,7 @@ void trace_update_counter(int value, const char *name, ...)
 void trace_begin(const char *name, ...)
 {; }
 
-void trace_end()
+void trace_end(void)
 {; }
 
 void trace_async_begin(int cookie, const char *name, ...)