Add brief description of header files for doxygen

diff --git a/os/include/assert.h b/os/include/assert.h
index ab20160..9c84ffa 100644 (file)
--- a/os/include/assert.h
+++ b/os/include/assert.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup ASSERT_KERNEL ASSERT
+ * @brief Provides APIs for Assertion
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/crc8.h b/os/include/crc8.h
index 7d72b76..4a01ac8 100644 (file)
--- a/os/include/crc8.h
+++ b/os/include/crc8.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup CRC_KERNEL CRC
+ * @brief Provides APIs for Cyclic Redundancy Check
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/debug.h b/os/include/debug.h
index 017b266..92a9370 100644 (file)
--- a/os/include/debug.h
+++ b/os/include/debug.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup DEBUG_KERNEL DEBUG
+ * @brief Provides APIs for Debug
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/dirent.h b/os/include/dirent.h
index afe31e6..b43128d 100644 (file)
--- a/os/include/dirent.h
+++ b/os/include/dirent.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup DIRENT_KERNEL DIRENT
+ * @brief Provides APIs for Directory Entries
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/errno.h b/os/include/errno.h
index 725ca4a..4a3b46c 100644 (file)
--- a/os/include/errno.h
+++ b/os/include/errno.h
@@ -51,6 +51,7 @@
  ************************************************************************/
 /**
  * @defgroup ERRNO_KERNEL ERRNO
+ * @brief Provides APIs for Error Number
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/fcntl.h b/os/include/fcntl.h
index edec385..45397fa 100644 (file)
--- a/os/include/fcntl.h
+++ b/os/include/fcntl.h
@@ -51,6 +51,7 @@
  ********************************************************************************/
 /**
  * @defgroup FCNTL_KERNEL FCNTL
+ * @brief Provides APIs for File Control
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/inttypes.h b/os/include/inttypes.h
index 9873d6d..3fd4ec5 100644 (file)
--- a/os/include/inttypes.h
+++ b/os/include/inttypes.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup INTTYPES_LIBC INTTYPES
+ * @brief Provides APIs for Integer Types
  * @ingroup KERNEL
  * @{
  */

diff --git a/os/include/libgen.h b/os/include/libgen.h
index 0245b41..85d6b27 100644 (file)
--- a/os/include/libgen.h
+++ b/os/include/libgen.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup LIBGEN_KERNEL LIBGEN
+ * @brief Provides APIs for Pattern matching functions
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/mqueue.h b/os/include/mqueue.h
index 829adf4..74e99bd 100644 (file)
--- a/os/include/mqueue.h
+++ b/os/include/mqueue.h
@@ -51,6 +51,7 @@
  ********************************************************************************/
 /**
  * @defgroup MQUEUE_KERNEL MQUEUE
+ * @brief Provides APIs for Message Queue
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/poll.h b/os/include/poll.h
index 24dce59..33682dc 100644 (file)
--- a/os/include/poll.h
+++ b/os/include/poll.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup POLL_KERNEL POLL
+ * @brief Provides APIs for Poll
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/pthread.h b/os/include/pthread.h
index 5cf1f95..76fb60a 100644 (file)
--- a/os/include/pthread.h
+++ b/os/include/pthread.h
@@ -51,6 +51,7 @@
  ********************************************************************************/
 /**
  * @defgroup PTHREAD_KERNEL PTHREAD
+ * @brief Provides APIs for Pthreads
  * @ingroup KERNEL
  */
 

diff --git a/os/include/queue.h b/os/include/queue.h
index 023d453..9141fd5 100644 (file)
--- a/os/include/queue.h
+++ b/os/include/queue.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup QUEUE_LIBC QUEUE
+ * @brief Provides APIs for Queue
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/sched.h b/os/include/sched.h
index ae723e1..9e87d4c 100644 (file)
--- a/os/include/sched.h
+++ b/os/include/sched.h
@@ -51,6 +51,7 @@
  ********************************************************************************/
 /**
  * @defgroup SCHED_KERNEL SCHED
+ * @brief Provides APIs for Scheduling
  * @ingroup KERNEL
  */
 

diff --git a/os/include/semaphore.h b/os/include/semaphore.h
index bd9176f..0b39ccb 100644 (file)
--- a/os/include/semaphore.h
+++ b/os/include/semaphore.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup SEMAPHORE_KERNEL SEMAPHORE
+ * @brief Provides APIs for Semaphore
  * @ingroup KERNEL
  */
 

diff --git a/os/include/signal.h b/os/include/signal.h
index 40ee1fe..f798975 100644 (file)
--- a/os/include/signal.h
+++ b/os/include/signal.h
@@ -51,6 +51,7 @@
  ********************************************************************************/
 /**
  * @defgroup SIGNAL_KERNEL SIGNAL
+ * @brief Provides APIs for Signal
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/spawn.h b/os/include/spawn.h
index 2cf81cf..ed02510 100644 (file)
--- a/os/include/spawn.h
+++ b/os/include/spawn.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup SPAWN_LIBC SPAWN
+ * @brief Provides APIs for Spawn
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/stdio.h b/os/include/stdio.h
index 9099153..7956262 100644 (file)
--- a/os/include/stdio.h
+++ b/os/include/stdio.h
@@ -55,6 +55,7 @@
 
 /**
  * @defgroup STDIO_LIBC STDIO
+ * @brief Provides APIs for Standard Input/Output
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/stdlib.h b/os/include/stdlib.h
index b8bc34f..91c2e7f 100644 (file)
--- a/os/include/stdlib.h
+++ b/os/include/stdlib.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup STDLIB_LIBC STDLIB
+ * @brief Provides APIs for Standard Library
  * @ingroup KERNEL
  * {
  */

diff --git a/os/include/string.h b/os/include/string.h
index f0d12f1..9346bb0 100644 (file)
--- a/os/include/string.h
+++ b/os/include/string.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup STRING_LIBC STRING
+ * @brief Provides APIs for String
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/sys/ioctl.h b/os/include/sys/ioctl.h
index d4b4c0e..8de34cd 100644 (file)
--- a/os/include/sys/ioctl.h
+++ b/os/include/sys/ioctl.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup IOCTL_KERNEL IOCTL
+ * @brief Provides APIs for Input/Output Control
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/sys/mount.h b/os/include/sys/mount.h
index ee4b937..dfba0f9 100644 (file)
--- a/os/include/sys/mount.h
+++ b/os/include/sys/mount.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup MOUNT_KERNEL MOUNT
+ * @brief Provides APIs for Mount
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/sys/select.h b/os/include/sys/select.h
index 8fb6129..43f3404 100644 (file)
--- a/os/include/sys/select.h
+++ b/os/include/sys/select.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup SELECT_KERNEL SELECT
+ * @brief Provides APIs for Select
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/sys/stat.h b/os/include/sys/stat.h
index 6b239b5..d2469e6 100644 (file)
--- a/os/include/sys/stat.h
+++ b/os/include/sys/stat.h
@@ -52,6 +52,7 @@
 
 /**
  * @defgroup STAT_KERNEL STAT
+ * @brief Provides APIs for File Status
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/syslog.h b/os/include/syslog.h
index 0be570d..2d4189e 100644 (file)
--- a/os/include/syslog.h
+++ b/os/include/syslog.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup SYSLOG_LIBC SYSLOG
+ * @brief Provides APIs for System Logging
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/termios.h b/os/include/termios.h
index ae597f7..296ecaf 100644 (file)
--- a/os/include/termios.h
+++ b/os/include/termios.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup TERMIOS_KERNEL TERMIOS
+ * @brief Provides APIs for Terminal Input/Output Interfaces
  * @ingroup KERNEL
  */
 

diff --git a/os/include/time.h b/os/include/time.h
index 130e94d..f91398e 100644 (file)
--- a/os/include/time.h
+++ b/os/include/time.h
@@ -51,6 +51,7 @@
  ********************************************************************************/
 /**
  * @defgroup TIME_KERNEL TIME
+ * @brief Provides APIs for Time
  * @ingroup KERNEL
  */
 

diff --git a/os/include/tinyara/clock.h b/os/include/tinyara/clock.h
index 1b55fcf..7598c8a 100644 (file)
--- a/os/include/tinyara/clock.h
+++ b/os/include/tinyara/clock.h
@@ -52,6 +52,7 @@
 
 /**
  * @defgroup CLOCK_KERNEL CLOCK
+ * @brief Provides APIs for Clock
  * @ingroup KERNEL
  *
  * @{

diff --git a/os/include/tinyara/math.h b/os/include/tinyara/math.h
index 919ca12..d5f406e 100644 (file)
--- a/os/include/tinyara/math.h
+++ b/os/include/tinyara/math.h
@@ -50,6 +50,7 @@
  ****************************************************************************/
 /**
  * @defgroup MATH_LIBC MATH
+ * @brief Provides APIs for Math
  * @ingroup KERNEL
  * @{
  */

diff --git a/os/include/unistd.h b/os/include/unistd.h
index f4815fa..c149d9f 100644 (file)
--- a/os/include/unistd.h
+++ b/os/include/unistd.h
@@ -51,6 +51,7 @@
  ****************************************************************************/
 /**
  * @defgroup UNISTD_KERNEL UNISTD
+ * @brief Provides APIs for Standard Symbolic Constants and Types
  * @ingroup KERNEL
  *
  * @{