Add doxygen comment for new apis : regex.h, debug.h
authorjc_.kim <jc_.kim@samsung.com>
Mon, 18 Sep 2017 05:01:35 +0000 (14:01 +0900)
committerjc_.kim <jc_.kim@samsung.com>
Mon, 18 Sep 2017 05:02:50 +0000 (14:02 +0900)
os/include/debug.h
os/include/tinyara/regex.h

index f70ac07..8488785 100644 (file)
@@ -1132,18 +1132,19 @@ Once LOGM is approved, each module should have its own index
 extern "C" {
 #endif
 
-/* Dump a buffer of data */
 /**
- * @cond
- * @internal
+ * @ingroup DEBUG_KERNEL
+ * @brief  Dump a buffer of data
+ *
+ * @param[in] message for buffer dump
+ * @param[in] buffer
+ * @param[in] length for buffer
+ * @return void
+ * @since Tizen RT v1.1
  */
 
 void lib_dumpbuffer(FAR const char *msg, FAR const uint8_t *buffer, unsigned int buflen);
 
-/**
- * @endcond
- */
-
 /* The system logging interfaces are normally accessed via the macros
  * provided above.  If the cross-compiler's C pre-processor supports a
  * variable number of macro arguments, then those macros below will map all
index 978d33d..211e352 100644 (file)
  * POSSIBILITY OF SUCH DAMAGE.
  *
  ****************************************************************************/
+/**
+ * @defgroup REGEX_KERNEL REGEX
+ * @brief regular-expression-matching types
+ * @ingroup KERNEL
+ *
+ * @{
+ */
 
 #ifndef __INCLUDE_REGEX_H
 #define __INCLUDE_REGEX_H
@@ -75,19 +82,14 @@ extern "C" {
 #define EXTERN extern
 #endif
 
-/****************************************************************************
- * Name: match
- *
- * Description:
- *   Simple shell-style filename pattern matcher written by Jef Poskanzer
- *   (See copyright notice in lib/lib_match.c).  This pattern matcher only
- *   handles '?', '*' and '**', and  multiple patterns separated by '|'.
- *
- * Returned Value:
- *   Returns 1 (match) or 0 (no-match).
- *
- ****************************************************************************/
-
+/**
+ * @ingroup REGEX_KERNEL
+ * @brief  Simple shell-style filename pattern matcher
+ * @param[in] pattern, only '?', '*' and '**', and multiple patterns separated by '|'.
+ * @param[in] string to match pattern
+ * @return Returns 1 (match) or 0 (no-match)
+ * @since Tizen RT v1.1
+ */
 EXTERN int match(const char *pattern, const char *string);
 
 #undef EXTERN
@@ -96,3 +98,6 @@ EXTERN int match(const char *pattern, const char *string);
 #endif
 
 #endif                                                 /* __INCLUDE_REGEX_H */
+/**
+ * @}
+ */