From 7b71fd2879a3ae425674c739a2d6650b6a61f325 Mon Sep 17 00:00:00 2001 From: "jc_.kim" Date: Tue, 10 Oct 2017 15:23:38 +0900 Subject: [PATCH] Modify doxygen comment for POSIX API and SYSTEM CALL API 1. replace POSIX APIs -> POSIX API 2. remove unnecessary square bracket --- os/include/dirent.h | 18 ++-- os/include/errno.h | 4 +- os/include/fcntl.h | 8 +- os/include/inttypes.h | 2 +- os/include/libgen.h | 4 +- os/include/mqueue.h | 36 ++++---- os/include/poll.h | 4 +- os/include/pthread.h | 200 ++++++++++++++++++++++----------------------- os/include/sched.h | 40 ++++----- os/include/semaphore.h | 24 +++--- os/include/signal.h | 54 ++++++------ os/include/spawn.h | 32 ++++---- os/include/stdio.h | 80 +++++++++--------- os/include/stdlib.h | 70 ++++++++-------- os/include/string.h | 58 ++++++------- os/include/sys/ioctl.h | 2 +- os/include/sys/mount.h | 4 +- os/include/sys/select.h | 4 +- os/include/sys/stat.h | 12 +-- os/include/sys/wait.h | 6 +- os/include/syslog.h | 4 +- os/include/termios.h | 4 +- os/include/time.h | 48 +++++------ os/include/tinyara/clock.h | 2 +- os/include/unistd.h | 64 +++++++-------- 25 files changed, 392 insertions(+), 392 deletions(-) diff --git a/os/include/dirent.h b/os/include/dirent.h index f9a4471..791641b 100644 --- a/os/include/dirent.h +++ b/os/include/dirent.h @@ -128,35 +128,35 @@ extern "C" { /** * @ingroup DIRENT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int closedir(FAR DIR *dirp); /** * @ingroup DIRENT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ FAR DIR *opendir(FAR const char *path); /** * @ingroup DIRENT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ FAR struct dirent *readdir(FAR DIR *dirp); /** * @ingroup DIRENT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int readdir_r(FAR DIR *dirp, FAR struct dirent *entry, FAR struct dirent **result); /** * @ingroup DIRENT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ void rewinddir(FAR DIR *dirp); diff --git a/os/include/errno.h b/os/include/errno.h index 6ac3567..7fb0ab8 100644 --- a/os/include/errno.h +++ b/os/include/errno.h @@ -443,7 +443,7 @@ FAR int *get_errno_ptr(void); #ifndef __DIRECT_ERRNO_ACCESS /** * @brief Set the value of the thread specific errno. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @param[in] errcode The thread specific errno will be set to this error code value. * @return none * @since Tizen RT v1.0 @@ -452,7 +452,7 @@ void set_errno(int errcode); /** * @brief Return the value of the thread specific errno. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @return The current value of the thread specific errno is returned. * @since Tizen RT v1.0 */ diff --git a/os/include/fcntl.h b/os/include/fcntl.h index 6095a0b..a69e112 100644 --- a/os/include/fcntl.h +++ b/os/include/fcntl.h @@ -195,15 +195,15 @@ extern "C" { /* POSIX-like File System Interfaces */ /** * @ingroup FCNTL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int open(const char *path, int oflag, ...); /** * @ingroup FCNTL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int fcntl(int fd, int cmd, ...); diff --git a/os/include/inttypes.h b/os/include/inttypes.h index b22a492..dc3dacc 100644 --- a/os/include/inttypes.h +++ b/os/include/inttypes.h @@ -201,7 +201,7 @@ extern "C" { */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ intmax_t imaxabs(intmax_t); diff --git a/os/include/libgen.h b/os/include/libgen.h index a830c66..37e7306 100644 --- a/os/include/libgen.h +++ b/os/include/libgen.h @@ -82,12 +82,12 @@ extern "C" { #define EXTERN extern #endif /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *basename(FAR char *path); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *dirname(FAR char *path); diff --git a/os/include/mqueue.h b/os/include/mqueue.h index 1cabe12..a4d21a1 100644 --- a/os/include/mqueue.h +++ b/os/include/mqueue.h @@ -110,61 +110,61 @@ extern "C" { * Public Function Prototypes ********************************************************************************/ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ mqd_t mq_open(FAR const char *mq_name, int oflags, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mq_close(mqd_t mqdes); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mq_unlink(FAR const char *mq_name); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mq_send(mqd_t mqdes, FAR const char *msg, size_t msglen, int prio); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mq_timedsend(mqd_t mqdes, FAR const char *msg, size_t msglen, int prio, FAR const struct timespec *abstime); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ ssize_t mq_receive(mqd_t mqdes, FAR char *msg, size_t msglen, FAR int *prio); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ ssize_t mq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen, FAR int *prio, FAR const struct timespec *abstime); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mq_notify(mqd_t mqdes, const struct sigevent *notification); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int mq_setattr(mqd_t mqdes, FAR const struct mq_attr *mq_stat, FAR struct mq_attr *oldstat); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int mq_getattr(mqd_t mqdes, FAR struct mq_attr *mq_stat); diff --git a/os/include/poll.h b/os/include/poll.h index e99c87b..6522f76 100644 --- a/os/include/poll.h +++ b/os/include/poll.h @@ -161,8 +161,8 @@ extern "C" { /** * @ingroup POLL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int poll(FAR struct pollfd *fds, nfds_t nfds, int timeout); diff --git a/os/include/pthread.h b/os/include/pthread.h index 2886bda..5b932bb 100644 --- a/os/include/pthread.h +++ b/os/include/pthread.h @@ -423,8 +423,8 @@ struct sched_param; /* Defined in sched.h */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_create(FAR pthread_t *thread, FAR const pthread_attr_t *attr, pthread_startroutine_t startroutine, pthread_addr_t arg); @@ -434,8 +434,8 @@ int pthread_create(FAR pthread_t *thread, FAR const pthread_attr_t *attr, pthrea */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_detach(pthread_t thread); @@ -445,35 +445,35 @@ int pthread_detach(pthread_t thread); */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ void pthread_exit(pthread_addr_t value) noreturn_function; /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cancel(pthread_t thread); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_setcancelstate(int state, FAR int *oldstate); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_setcanceltype(int type, FAR int *oldtype); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ void pthread_testcancel(void); @@ -490,8 +490,8 @@ void pthread_cleanup_push(pthread_cleanup_t routine, FAR void *arg); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_join(pthread_t thread, FAR pthread_addr_t *value); @@ -499,8 +499,8 @@ int pthread_join(pthread_t thread, FAR pthread_addr_t *value); /* A thread may tell the scheduler that its processor can be made available. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ void pthread_yield(void); @@ -508,8 +508,8 @@ void pthread_yield(void); /* A thread may obtain a copy of its own thread handle. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ #define pthread_self() ((pthread_t)getpid()) @@ -517,8 +517,8 @@ void pthread_yield(void); /* Compare two thread IDs. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ #define pthread_equal(t1, t2) ((t1) == (t2)) @@ -526,21 +526,21 @@ void pthread_yield(void); /* Thread scheduling parameters */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_getschedparam(pthread_t thread, FAR int *policy, FAR struct sched_param *param); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_setschedparam(pthread_t thread, int policy, FAR const struct sched_param *param); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_setschedprio(pthread_t thread, int prio); @@ -548,22 +548,22 @@ int pthread_setschedprio(pthread_t thread, int prio); /* Thread-specific Data Interfaces */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_key_create(FAR pthread_key_t *key, CODE void (*destructor)(FAR void *)); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_setspecific(pthread_key_t key, FAR const void *value); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ FAR void *pthread_getspecific(pthread_key_t key); @@ -580,36 +580,36 @@ int pthread_key_delete(pthread_key_t key); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_mutex_init(FAR pthread_mutex_t *mutex, FAR const pthread_mutexattr_t *attr); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_mutex_destroy(FAR pthread_mutex_t *mutex); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_mutex_lock(FAR pthread_mutex_t *mutex); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_mutex_trylock(FAR pthread_mutex_t *mutex); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_mutex_unlock(FAR pthread_mutex_t *mutex); @@ -617,15 +617,15 @@ int pthread_mutex_unlock(FAR pthread_mutex_t *mutex); /* A thread can create and delete condition variables. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cond_init(FAR pthread_cond_t *cond, FAR const pthread_condattr_t *attr); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cond_destroy(FAR pthread_cond_t *cond); @@ -633,15 +633,15 @@ int pthread_cond_destroy(FAR pthread_cond_t *cond); /* A thread can signal to and broadcast on a condition variable. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cond_broadcast(FAR pthread_cond_t *cond); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cond_signal(FAR pthread_cond_t *cond); @@ -649,8 +649,8 @@ int pthread_cond_signal(FAR pthread_cond_t *cond); /* A thread can wait for a condition variable to be signalled or broadcast. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cond_wait(FAR pthread_cond_t *cond, FAR pthread_mutex_t *mutex); @@ -658,8 +658,8 @@ int pthread_cond_wait(FAR pthread_cond_t *cond, FAR pthread_mutex_t *mutex); /* A thread can perform a timed wait on a condition variable. */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_cond_timedwait(FAR pthread_cond_t *cond, FAR pthread_mutex_t *mutex, FAR const struct timespec *abstime); @@ -667,22 +667,22 @@ int pthread_cond_timedwait(FAR pthread_cond_t *cond, FAR pthread_mutex_t *mutex, /* Barriers */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_barrier_destroy(FAR pthread_barrier_t *barrier); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_barrier_init(FAR pthread_barrier_t *barrier, FAR const pthread_barrierattr_t *attr, unsigned int count); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_barrier_wait(FAR pthread_barrier_t *barrier); @@ -690,8 +690,8 @@ int pthread_barrier_wait(FAR pthread_barrier_t *barrier); /* Pthread initialization */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_once(FAR pthread_once_t *once_control, CODE void (*init_routine)(void)); @@ -699,15 +699,15 @@ int pthread_once(FAR pthread_once_t *once_control, CODE void (*init_routine)(voi /* Pthread signal management APIs */ /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_kill(pthread_t thread, int sig); /** * @ingroup PTHREAD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pthread_sigmask(int how, FAR const sigset_t *set, FAR sigset_t *oset); @@ -717,7 +717,7 @@ int pthread_sigmask(int how, FAR const sigset_t *set, FAR sigset_t *oset); * @{ */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_init(FAR pthread_attr_t *attr); @@ -725,7 +725,7 @@ int pthread_attr_init(FAR pthread_attr_t *attr); /* An attributes object can be deleted when it is no longer needed. */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_destroy(pthread_attr_t *attr); @@ -733,100 +733,100 @@ int pthread_attr_destroy(pthread_attr_t *attr); /* Set or obtain the default scheduling algorithm */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_setschedpolicy(FAR pthread_attr_t *attr, int policy); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_getschedpolicy(FAR const pthread_attr_t *attr, int *policy); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_setschedparam(FAR pthread_attr_t *attr, FAR const struct sched_param *param); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_getschedparam(FAR const pthread_attr_t *attr, FAR struct sched_param *param); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_setinheritsched(FAR pthread_attr_t *attr, int inheritsched); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_getinheritsched(FAR const pthread_attr_t *attr, FAR int *inheritsched); /* Set or obtain the default stack size */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_setstacksize(FAR pthread_attr_t *attr, long stacksize); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_attr_getstacksize(FAR const pthread_attr_t *attr, long *stackaddr); /* Create, operate on, and destroy mutex attributes. */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_mutexattr_init(FAR pthread_mutexattr_t *attr); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_mutexattr_destroy(FAR pthread_mutexattr_t *attr); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_mutexattr_getpshared(FAR const pthread_mutexattr_t *attr, FAR int *pshared); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_mutexattr_setpshared(FAR pthread_mutexattr_t *attr, int pshared); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *type); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int type); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_mutexattr_getprotocol(FAR const pthread_mutexattr_t *attr, FAR int *protocol); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_mutexattr_setprotocol(FAR pthread_mutexattr_t *attr, int protocol); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_mutexattr_getrobust(FAR const pthread_mutexattr_t *attr, FAR int *robust); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_mutexattr_setrobust(FAR pthread_mutexattr_t *attr, @@ -834,34 +834,34 @@ int pthread_mutexattr_setrobust(FAR pthread_mutexattr_t *attr, /* Operations on condition variables */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_condattr_init(FAR pthread_condattr_t *attr); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_condattr_destroy(FAR pthread_condattr_t *attr); /* Barrier attributes */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_barrierattr_destroy(FAR pthread_barrierattr_t *attr); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_barrierattr_init(FAR pthread_barrierattr_t *attr); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_barrierattr_getpshared(FAR const pthread_barrierattr_t *attr, FAR int *pshared); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pthread_barrierattr_setpshared(FAR pthread_barrierattr_t *attr, int pshared); @@ -869,47 +869,47 @@ int pthread_barrierattr_setpshared(FAR pthread_barrierattr_t *attr, int pshared) /* Pthread rwlock */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_destroy(FAR pthread_rwlock_t *rw_lock); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_init(FAR pthread_rwlock_t *rw_lock, FAR const pthread_rwlockattr_t *attr); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_rdlock(pthread_rwlock_t *lock); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_timedrdlock(FAR pthread_rwlock_t *lock, FAR const struct timespec *abstime); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_timedwrlock(FAR pthread_rwlock_t *lock, FAR const struct timespec *abstime); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_tryrdlock(FAR pthread_rwlock_t *lock); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_trywrlock(FAR pthread_rwlock_t *lock); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_unlock(FAR pthread_rwlock_t *lock); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int pthread_rwlock_wrlock(FAR pthread_rwlock_t *lock); diff --git a/os/include/sched.h b/os/include/sched.h index 76a2030..9166f18 100644 --- a/os/include/sched.h +++ b/os/include/sched.h @@ -153,7 +153,7 @@ int task_activate(FAR struct tcb_s *tcb); * @ingroup SCHED_KERNEL * @brief creates and activates a new task with a specified * priority and returns its system-assigned ID. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * The entry address entry is the address of the "main" function of the * task. This function will be called once the C environment has been * set up. The specified function will be called with four arguments. @@ -179,7 +179,7 @@ int task_create(FAR const char *name, int priority, int stack_size, main_t entry /** * @ingroup SCHED_KERNEL * @brief causes a specified task to cease to exist. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * Its stack and TCB will be deallocated. This function is * the companion to task_create(). * This is the version of the function exposed to the user; it is simply @@ -211,7 +211,7 @@ int task_delete(pid_t pid); /** * @ingroup SCHED_KERNEL * @brief restart a task. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * The task is first terminated and then * reinitialized with same ID, priority, original entry point, stack size, * and parameters it had when it was first started. @@ -235,36 +235,36 @@ void task_testcancel(void); /* Task Scheduling Interfaces (based on POSIX APIs) */ /** * @ingroup SCHED_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sched_setparam(pid_t pid, const struct sched_param *param); /** * @ingroup SCHED_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sched_getparam(pid_t pid, struct sched_param *param); /** * @ingroup SCHED_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sched_setscheduler(pid_t pid, int policy, FAR const struct sched_param *param); /** * @ingroup SCHED_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sched_getscheduler(pid_t pid); /** * @ingroup SCHED_KERNEL - * @details [SYSTEM CALL API] - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sched_yield(void); @@ -276,12 +276,12 @@ int sched_yield(void); * @{ */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sched_get_priority_max(int policy); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sched_get_priority_min(int policy); @@ -289,8 +289,8 @@ int sched_get_priority_min(int policy); * @} */ /** * @ingroup SCHED_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sched_rr_get_interval(pid_t pid, FAR struct timespec *interval); @@ -299,7 +299,7 @@ int sched_rr_get_interval(pid_t pid, FAR struct timespec *interval); /** * @ingroup SCHED_KERNEL * @brief disable context switching - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @return On success, OK is returned. On failure, ERROR is returned. * @since Tizen RT v1.0 */ @@ -307,7 +307,7 @@ int sched_lock(void); /** * @ingroup SCHED_KERNEL * @brief re-enable the context switching which blocked from sched_lock() - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * This function decrements the preemption lock count. Typically this * is paired with sched_lock() and concludes a critical section of * code. Preemption will not be unlocked until sched_unlock() has @@ -321,7 +321,7 @@ int sched_unlock(void); /** * @ingroup SCHED_KERNEL * @brief returns the current value of the lockcount - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * This function returns the current value of the lockcount. If zero, * pre-emption is enabled; if non-zero, this value indicates the number * of times that sched_lock() has been called on this thread of diff --git a/os/include/semaphore.h b/os/include/semaphore.h index 0b39ccb..4c69d1e 100644 --- a/os/include/semaphore.h +++ b/os/include/semaphore.h @@ -166,48 +166,48 @@ struct timespec; /* Defined in time.h */ /* Counting Semaphore Interfaces (based on POSIX APIs) */ /** * @ingroup SEMAPHORE_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sem_init(FAR sem_t *sem, int pshared, unsigned int value); /** * @ingroup SEMAPHORE_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sem_destroy(FAR sem_t *sem); /** * @ingroup SEMAPHORE_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sem_wait(FAR sem_t *sem); /** * @ingroup SEMAPHORE_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sem_timedwait(FAR sem_t *sem, FAR const struct timespec *abstime); /** * @ingroup SEMAPHORE_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sem_trywait(FAR sem_t *sem); /** * @ingroup SEMAPHORE_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sem_post(FAR sem_t *sem); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @ingroup SEMAPHORE_KERNEL * @since Tizen RT v1.0 */ diff --git a/os/include/signal.h b/os/include/signal.h index 7f3c69e..6091c65 100644 --- a/os/include/signal.h +++ b/os/include/signal.h @@ -294,8 +294,8 @@ extern "C" { #endif /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int kill(pid_t pid, int sig); @@ -310,57 +310,57 @@ int kill(pid_t pid, int sig); */ int sigemptyset(FAR sigset_t *set); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sigfillset(FAR sigset_t *set); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sigaddset(FAR sigset_t *set, int signo); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sigdelset(FAR sigset_t *set, int signo); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sigismember(FAR const sigset_t *set, int signo); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sighold(int sig); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int sigignore(int sig); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int sigpause(int sig); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int raise(int sig); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sigrelse(int sig); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ CODE void (*sigset(int sig, CODE void (*func)(int sig)))(int sig); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ CODE void (*signal(int sig, CODE void (*func)(int sig)))(int sig); @@ -370,50 +370,50 @@ CODE void (*signal(int sig, CODE void (*func)(int sig)))(int sig); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sigaction(int sig, FAR const struct sigaction *act, FAR struct sigaction *oact); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sigprocmask(int how, FAR const sigset_t *set, FAR sigset_t *oset); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sigpending(FAR sigset_t *set); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sigsuspend(FAR const sigset_t *sigmask); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sigwaitinfo(FAR const sigset_t *set, FAR struct siginfo *value); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int sigtimedwait(FAR const sigset_t *set, FAR struct siginfo *value, FAR const struct timespec *timeout); /** * @ingroup SIGNAL_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ #ifdef CONFIG_CAN_PASS_STRUCTS diff --git a/os/include/spawn.h b/os/include/spawn.h index bd1aba3..5b5f17c 100644 --- a/os/include/spawn.h +++ b/os/include/spawn.h @@ -180,29 +180,29 @@ int task_spawn(FAR pid_t *pid, FAR const char *name, main_t entry, FAR const pos /* File action interfaces ***************************************************/ /* File action initialization and destruction */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawn_file_actions_init(FAR posix_spawn_file_actions_t *file_actions); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawn_file_actions_destroy(FAR posix_spawn_file_actions_t *file_actions); /* Add file action interfaces */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawn_file_actions_addclose(FAR posix_spawn_file_actions_t *file_actions, int fd); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int posix_spawn_file_actions_adddup2(FAR posix_spawn_file_actions_t *file_actions, int fd1, int fd2); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawn_file_actions_addopen(FAR posix_spawn_file_actions_t *file_actions, int fd, FAR const char *path, int oflags, mode_t mode); @@ -210,7 +210,7 @@ int posix_spawn_file_actions_addopen(FAR posix_spawn_file_actions_t *file_action /* Spawn attributes interfaces **********************************************/ /* Spawn attributes initialization and destruction */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_init(FAR posix_spawnattr_t *attr); @@ -224,25 +224,25 @@ int posix_spawnattr_init(FAR posix_spawnattr_t *attr); /* Get spawn attributes interfaces */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_getflags(FAR const posix_spawnattr_t *attr, FAR short *flags); #define posix_spawnattr_getpgroup(attr, group) (ENOSYS) /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_getschedparam(FAR const posix_spawnattr_t *attr, FAR struct sched_param *param); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_getschedpolicy(FAR const posix_spawnattr_t *attr, FAR int *policy); #define posix_spawnattr_getsigdefault(attr, sigdefault) (ENOSYS) #ifndef CONFIG_DISABLE_SIGNALS /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_getsigmask(FAR const posix_spawnattr_t *attr, FAR sigset_t *sigmask); @@ -252,25 +252,25 @@ int posix_spawnattr_getsigmask(FAR const posix_spawnattr_t *attr, FAR sigset_t * /* Set spawn attributes interfaces */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_setflags(FAR posix_spawnattr_t *attr, short flags); #define posix_spawnattr_setpgroup(attr, group) (ENOSYS) /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_setschedparam(FAR posix_spawnattr_t *attr, FAR const struct sched_param *param); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_setschedpolicy(FAR posix_spawnattr_t *attr, int policy); #define posix_spawnattr_setsigdefault(attr, sigdefault) (ENOSYS) #ifndef CONFIG_DISABLE_SIGNALS /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int posix_spawnattr_setsigmask(FAR posix_spawnattr_t *attr, FAR const sigset_t *sigmask); @@ -308,12 +308,12 @@ int task_spawnattr_setstacksize(FAR posix_spawnattr_t *attr, size_t stacksize); #ifdef CONFIG_DEBUG /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ void posix_spawn_file_actions_dump(FAR posix_spawn_file_actions_t *file_actions); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ void posix_spawnattr_dump(FAR posix_spawnattr_t *attr); diff --git a/os/include/stdio.h b/os/include/stdio.h index 9afe0c6..9a73229 100644 --- a/os/include/stdio.h +++ b/os/include/stdio.h @@ -118,22 +118,22 @@ */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define putc(c, s) fputc((c), (s)) /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define putchar(c) fputc(c, stdout) /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define getc(s) fgetc(s) /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define getchar() fgetc(stdin) @@ -202,107 +202,107 @@ void clearerr(register FILE *stream); * @endcond */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fclose(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fflush(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int feof(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int ferror(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fileno(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fgetc(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fgetpos(FAR FILE *stream, FAR fpos_t *pos); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ char *fgets(FAR char *s, int n, FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR FILE *fopen(FAR const char *path, FAR const char *type); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ FAR FILE *freopen(FAR const char *path, FAR const char *mode, FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ void setbuf(FAR FILE *stream, FAR char *buf); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int setvbuf(FAR FILE *stream, FAR char *buffer, int mode, size_t size); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fprintf(FAR FILE *stream, FAR const char *format, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fputc(int c, FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fputs(FAR const char *s, FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t fread(FAR void *ptr, size_t size, size_t n_items, FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fseek(FAR FILE *stream, long int offset, int whence); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int fsetpos(FAR FILE *stream, FAR fpos_t *pos); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ long ftell(FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t fwrite(FAR const void *ptr, size_t size, size_t n_items, FAR FILE *stream); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *gets(FAR char *s); @@ -332,7 +332,7 @@ FAR char *gets(FAR char *s); */ FAR char *gets_s(FAR char *s, rsize_t n); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int ungetc(int c, FAR FILE *stream); @@ -340,12 +340,12 @@ int ungetc(int c, FAR FILE *stream); /* Operations on the stdout stream, buffers, paths, and the whole printf-family */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int printf(FAR const char *format, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int puts(FAR const char *s); @@ -358,43 +358,43 @@ int rename(FAR const char *oldpath, FAR const char *newpath); * @endcond */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sprintf(FAR char *buf, FAR const char *format, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int asprintf(FAR char **ptr, FAR const char *fmt, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int snprintf(FAR char *buf, size_t size, FAR const char *format, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int sscanf(FAR const char *buf, FAR const char *fmt, ...); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ void perror(FAR const char *s); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int vprintf(FAR const char *format, va_list ap); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int vfprintf(FAR FILE *stream, const char *format, va_list ap); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int vsprintf(FAR char *buf, const char *format, va_list ap); @@ -407,12 +407,12 @@ int avsprintf(FAR char **ptr, const char *fmt, va_list ap); * @endcond */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int vsnprintf(FAR char *buf, size_t size, const char *format, va_list ap); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int vsscanf(FAR const char *buf, FAR const char *s, va_list ap); @@ -424,7 +424,7 @@ int vsscanf(FAR const char *buf, FAR const char *s, va_list ap); * Part 1 (dprintf and vdprintf) */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR FILE *fdopen(int fd, FAR const char *type); @@ -448,7 +448,7 @@ FAR char *tmpnam(FAR char *s); */ FAR char *tempnam(FAR const char *dir, FAR const char *pfx); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int remove(FAR const char *path); diff --git a/os/include/stdlib.h b/os/include/stdlib.h index bdfb58d..b6e182a 100644 --- a/os/include/stdlib.h +++ b/os/include/stdlib.h @@ -179,7 +179,7 @@ extern "C" { void srand(unsigned int seed); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int rand(void); @@ -199,15 +199,15 @@ int rand(void); FAR char *get_environ_ptr(size_t *envsize); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ FAR char *getenv(FAR const char *name); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int putenv(FAR const char *string); @@ -215,21 +215,21 @@ int putenv(FAR const char *string); * @ingroup STDLIB_LIBC * @brief clears the environment of all name-value pairs * and sets the value of the external variable environ to NULL - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int clearenv(void); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int setenv(const char *name, const char *value, int overwrite); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int unsetenv(const char *name); @@ -238,22 +238,22 @@ int unsetenv(const char *name); /* Process exit functions */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ void exit(int status) noreturn_function; /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ void abort(void) noreturn_function; #ifdef CONFIG_SCHED_ATEXIT /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int atexit(CODE void (*func)(void)); @@ -262,7 +262,7 @@ int atexit(CODE void (*func)(void)); /** * @ingroup STDLIB_LIBC * @brief register a function to be called at program exit - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * * @param[in] func A pointer to the function to be called when the task exits. * @param[in] arg An argument that will be provided to the on_exit() function when @@ -287,60 +287,60 @@ void _exit(int status); /* See unistd.h */ /* String to binary conversions */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ long strtol(const char *, char **, int); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ unsigned long strtoul(const char *, char **, int); #ifdef CONFIG_HAVE_LONG_LONG /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ long long strtoll(const char *, char **, int); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ unsigned long long strtoull(const char *, char **, int); #endif /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ double_t strtod(const char *, char **); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define atoi(nptr) strtol((nptr), NULL, 10) /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define atol(nptr) strtol((nptr), NULL, 10) #ifdef CONFIG_HAVE_LONG_LONG /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define atoll(nptr) strtoll((nptr), NULL, 10) #endif /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define atof(nptr) strtod((nptr), NULL) @@ -361,19 +361,19 @@ char *itoa(int value, char *str, int base); /* Memory Management */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *malloc(size_t); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ void free(FAR void *); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *realloc(FAR void *, size_t); @@ -398,7 +398,7 @@ FAR void *memalign(size_t, size_t); FAR void *zalloc(size_t); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *calloc(size_t, size_t); @@ -406,20 +406,20 @@ FAR void *calloc(size_t, size_t); /* Misc */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int abs(int j); /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ long int labs(long int j); #ifdef CONFIG_HAVE_LONG_LONG /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ long long int llabs(long long int j); @@ -428,7 +428,7 @@ long long int llabs(long long int j); #ifdef CONFIG_CAN_PASS_STRUCTS /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ div_t div(int numer, int denom); @@ -464,7 +464,7 @@ int mkstemp(FAR char *path_template); /* Sorting */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ void qsort(void *base, size_t nmemb, size_t size, int (*compar)(const void *, const void *)); @@ -472,7 +472,7 @@ void qsort(void *base, size_t nmemb, size_t size, int (*compar)(const void *, co /* Binary search */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ FAR void *bsearch(FAR const void *key, FAR const void *base, size_t nel, size_t width, CODE int (*compar)(FAR const void *, FAR const void *)); diff --git a/os/include/string.h b/os/include/string.h index 3264279..6e36d72 100644 --- a/os/include/string.h +++ b/os/include/string.h @@ -95,148 +95,148 @@ extern "C" { #endif /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strdup(FAR const char *s); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strndup(FAR const char *s, size_t size); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR const char *strerror(int); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t strlen(FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t strnlen(FAR const char *, size_t); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strcat(FAR char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strncat(FAR char *, FAR const char *, size_t); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int strcmp(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int strncmp(FAR const char *, FAR const char *, size_t); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int strcasecmp(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int strncasecmp(FAR const char *, FAR const char *, size_t); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strcpy(char *dest, FAR const char *src); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *stpcpy(char *dest, FAR const char *src); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strncpy(char *, FAR const char *, size_t); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strpbrk(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strchr(FAR const char *s, int c); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strrchr(FAR const char *s, int c); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t strspn(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t strcspn(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strstr(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strcasestr(FAR const char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strtok(FAR char *, FAR const char *); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *strtok_r(FAR char *, FAR const char *, FAR char **); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *memchr(FAR const void *s, int c, size_t n); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *memccpy(FAR void *s1, FAR const void *s2, int c, size_t n); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int memcmp(FAR const void *s1, FAR const void *s2, size_t n); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *memcpy(FAR void *dest, FAR const void *src, size_t n); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *memmove(FAR void *dest, FAR const void *src, size_t count); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR void *memset(FAR void *s, int c, size_t n); diff --git a/os/include/sys/ioctl.h b/os/include/sys/ioctl.h index b532036..f4b877d 100644 --- a/os/include/sys/ioctl.h +++ b/os/include/sys/ioctl.h @@ -129,7 +129,7 @@ extern "C" { /** * @ingroup IOCTL_KERNEL * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ #ifdef CONFIG_LIBC_IOCTL_VARIADIC diff --git a/os/include/sys/mount.h b/os/include/sys/mount.h index e02b9b6..c90f016 100644 --- a/os/include/sys/mount.h +++ b/os/include/sys/mount.h @@ -100,7 +100,7 @@ extern "C" { * @param[in] The flags for mount. * @param[in] Mountpoint private data. * @return On success, Zero is returned. On failure, -1 is returned and errno is set appropriately. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mount(const char *source, const char *target, const char *filesystemtype, unsigned long mountflags, const void *data); @@ -109,7 +109,7 @@ int mount(const char *source, const char *target, const char *filesystemtype, un * @brief detaches the filesystem mounted at the target path. * @param[in] The root path of filesystem to be detached. * @return On success, Zero is returned. On failure, -1 is returned and errno is set appropriately. - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int umount(const char *target); diff --git a/os/include/sys/select.h b/os/include/sys/select.h index fb6bbbd..37a15c6 100644 --- a/os/include/sys/select.h +++ b/os/include/sys/select.h @@ -143,8 +143,8 @@ extern "C" { /** * @ingroup SELECT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ EXTERN int select(int nfds, FAR fd_set *readfds, FAR fd_set *writefds, FAR fd_set *exceptfds, FAR struct timeval *timeout); diff --git a/os/include/sys/stat.h b/os/include/sys/stat.h index ed02186..001a1c7 100644 --- a/os/include/sys/stat.h +++ b/os/include/sys/stat.h @@ -156,22 +156,22 @@ extern "C" { /** * @ingroup STAT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mkdir(FAR const char *pathname, mode_t mode); /** * @ingroup STAT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int mkfifo(FAR const char *pathname, mode_t mode); /** * @ingroup STAT_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int stat(const char *path, FAR struct stat *buf); diff --git a/os/include/sys/wait.h b/os/include/sys/wait.h index f7f8c90..e6bb9f7 100644 --- a/os/include/sys/wait.h +++ b/os/include/sys/wait.h @@ -124,7 +124,7 @@ extern "C" { /** * @ingroup SCHED_KERNEL * @brief suspend execution of the calling thread - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * suspend execution of the calling thread until * status information for one of its terminated child processes is * available, or until delivery of a signal whose action is either to @@ -146,7 +146,7 @@ EXTERN pid_t wait(FAR int *stat_loc); /** * @ingroup SCHED_KERNEL * @brief suspend execution of the calling thread - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * The waitid() function suspends the calling thread until one child of * the process containing the calling thread changes state. It records the * current state of a child in the structure pointed to by 'info'. If a @@ -209,7 +209,7 @@ EXTERN int waitid(idtype_t idtype, id_t id, FAR siginfo_t *info, int options); /** * @ingroup SCHED_KERNEL * @brief suspend execution of the calling thread - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * obtain status information pertaining to one * of the caller's child processes. The waitpid() function will suspend * execution of the calling thread until status information for one of the diff --git a/os/include/syslog.h b/os/include/syslog.h index 761db06..6158865 100644 --- a/os/include/syslog.h +++ b/os/include/syslog.h @@ -193,7 +193,7 @@ void closelog(void); * ****************************************************************************/ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int syslog(int priority, FAR const char *format, ...); @@ -294,7 +294,7 @@ int lowvsyslog(int priority, FAR const char *format, va_list ap); * ****************************************************************************/ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int setlogmask(int mask); diff --git a/os/include/termios.h b/os/include/termios.h index 296ecaf..529675b 100644 --- a/os/include/termios.h +++ b/os/include/termios.h @@ -325,7 +325,7 @@ int tcflush(int fd, int cmd); /* Get the parameters associated with the terminal */ /** * @ingroup TERMIOS_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int tcgetattr(int fd, FAR struct termios *termiosp); @@ -349,7 +349,7 @@ int tcsendbreak(int fd, int duration); /* Set the parameters associated with the terminal */ /** * @ingroup TERMIOS_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int tcsetattr(int fd, int options, FAR const struct termios *termiosp); diff --git a/os/include/time.h b/os/include/time.h index da16905..f442a43 100644 --- a/os/include/time.h +++ b/os/include/time.h @@ -126,13 +126,13 @@ /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define localtime(c) gmtime(c) /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ #define localtime_r(c, r) gmtime_r(c, r) @@ -219,41 +219,41 @@ extern "C" { /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int clock_settime(clockid_t clockid, FAR const struct timespec *tp); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int clock_gettime(clockid_t clockid, FAR struct timespec *tp); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int clock_getres(clockid_t clockid, FAR struct timespec *res); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ time_t mktime(FAR struct tm *tp); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR struct tm *gmtime(FAR const time_t *timer); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR struct tm *gmtime_r(FAR const time_t *timer, FAR struct tm *result); @@ -261,13 +261,13 @@ FAR struct tm *gmtime_r(FAR const time_t *timer, FAR struct tm *result); #ifdef CONFIG_LIBC_LOCALTIME /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR struct tm *localtime(FAR const time_t *timer); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR struct tm *localtime_r(FAR const time_t *timer, FAR struct tm *result); @@ -275,7 +275,7 @@ FAR struct tm *localtime_r(FAR const time_t *timer, FAR struct tm *result); #endif /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ size_t strftime(char *s, size_t max, FAR const char *format, FAR const struct tm *tm); @@ -327,36 +327,36 @@ float difftime(time_t time1, time_t time0); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ time_t time(FAR time_t *tloc); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int timer_create(clockid_t clockid, FAR struct sigevent *evp, FAR timer_t *timerid); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int timer_delete(timer_t timerid); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int timer_settime(timer_t timerid, int flags, FAR const struct itimerspec *value, FAR struct itimerspec *ovalue); /** * @ingroup TIME_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int timer_gettime(timer_t timerid, FAR struct itimerspec *value); @@ -372,7 +372,7 @@ int timer_getoverrun(timer_t timerid); /** * @ingroup TIME_KERNEL * @brief high-resolution sleep - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * * @param[in] rqtp The amount of time to be suspended from execution. * @param[in] rmtp If the rmtp argument is non-NULL, the timespec structure diff --git a/os/include/tinyara/clock.h b/os/include/tinyara/clock.h index 36a48ec..831653f 100644 --- a/os/include/tinyara/clock.h +++ b/os/include/tinyara/clock.h @@ -306,7 +306,7 @@ void clock_synchronize(void); /** * @ingroup CLOCK_KERNEL * @brief Return the current value of the 32/64-bit system timer counter - * @details [SYSTEM CALL API] + * @details SYSTEM CALL API * * @return The current value of the system timer counter is returned. * @since Tizen RT v1.0 diff --git a/os/include/unistd.h b/os/include/unistd.h index 234d49b..064ecd7 100644 --- a/os/include/unistd.h +++ b/os/include/unistd.h @@ -193,7 +193,7 @@ EXTERN int optopt; /* unrecognized option character */ pid_t vfork(void); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ pid_t getpid(void); @@ -207,19 +207,19 @@ void _exit(int status) noreturn_function; */ /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ unsigned int sleep(unsigned int seconds); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int usleep(useconds_t usec); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int pause(void); @@ -231,56 +231,56 @@ int pause(void); * @{ */ /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int close(int fd); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int dup(int fd); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int dup2(int fd1, int fd2); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int fsync(int fd); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ off_t lseek(int fd, off_t offset, int whence); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ ssize_t read(int fd, FAR void *buf, size_t nbytes); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ ssize_t write(int fd, FAR const void *buf, size_t nbytes); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ ssize_t pread(int fd, FAR void *buf, size_t nbytes, off_t offset); /** - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ ssize_t pwrite(int fd, FAR const void *buf, size_t nbytes, off_t offset); @@ -306,8 +306,8 @@ FAR void *sbrk(intptr_t incr); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int pipe(int fd[2]); @@ -316,13 +316,13 @@ int pipe(int fd[2]); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int chdir(FAR const char *path); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ FAR char *getcwd(FAR char *buf, size_t size); @@ -330,21 +330,21 @@ FAR char *getcwd(FAR char *buf, size_t size); /* File path operations */ /** * @ingroup STDLIB_LIBC - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.1 */ int access(FAR const char *path, int amode); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int rmdir(FAR const char *pathname); /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details [SYSTEM CALL API] + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @details SYSTEM CALL API * @since Tizen RT v1.0 */ int unlink(FAR const char *pathname); @@ -367,7 +367,7 @@ int execv(FAR const char *path, FAR char *const argv[]); /* Other */ /** * @ingroup UNISTD_KERNEL - * @brief POSIX APIs (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) + * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @since Tizen RT v1.0 */ int getopt(int argc, FAR char *const argv[], FAR const char *optstring); -- 2.7.4