diff options
author | sunghan-chang <sh924.chang@samsung.com> | 2017-10-17 22:11:30 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-10-17 22:11:30 +0900 |
commit | 91ce2a11e56216f61818b1c5bd18336b303b9c3f (patch) | |
tree | 62887bcecbd52d8893b69a58284683779810a41d | |
parent | 7dca9debd2d1ede60819c276de6f7d36d59d6abc (diff) | |
parent | 3f2442ec7fcf0ddc90ee63af19822e9669c49af9 (diff) | |
download | tinyara-91ce2a11e56216f61818b1c5bd18336b303b9c3f.tar.gz tinyara-91ce2a11e56216f61818b1c5bd18336b303b9c3f.tar.bz2 tinyara-91ce2a11e56216f61818b1c5bd18336b303b9c3f.zip |
Merge pull request #848 from jeongarmy/modify_doxygen
doxygen : add include path, missing brief, parameters and return for fs APIs in include/sys
-rw-r--r-- | os/include/sys/mount.h | 25 | ||||
-rw-r--r-- | os/include/sys/select.h | 6 |
2 files changed, 18 insertions, 13 deletions
diff --git a/os/include/sys/mount.h b/os/include/sys/mount.h index c90f016f..8b90cfed 100644 --- a/os/include/sys/mount.h +++ b/os/include/sys/mount.h @@ -93,23 +93,25 @@ extern "C" { /** * @ingroup MOUNT_KERNEL - * @brief attaches filesystem to the root filesystem at the target path. - * @param[in] The name of block device to be attached. - * @param[in] The root path of filesystem. - * @param[in] The type of filesystem. - * @param[in] The flags for mount. - * @param[in] Mountpoint private data. + * @brief attaches filesystem to the root filesystem at the target path + * @details @b #include <sys/mount.h> \n + * SYSTEM CALL API \n + * @param[in] source the name of block device to be attached + * @param[in] target the root path of filesystem + * @param[in] filesystemtype the type of filesystem + * @param[in] mountflags the flags for mount + * @param[in] data mountpoint private data * @return On success, Zero is returned. On failure, -1 is returned and errno is set appropriately. - * @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); /** * @ingroup MOUNT_KERNEL - * @brief detaches the filesystem mounted at the target path. - * @param[in] The root path of filesystem to be detached. + * @brief detaches the filesystem mounted at the target path + * @details @b #include <sys/mount.h> \n + * SYSTEM CALL API \n + * @param[in] target 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 * @since Tizen RT v1.0 */ int umount(const char *target); @@ -121,4 +123,5 @@ int umount(const char *target); #endif /* __INCLUDE_SYS_MOUNT_H */ /** - * @} */ + * @} + */ diff --git a/os/include/sys/select.h b/os/include/sys/select.h index 37a15c6f..2db556f9 100644 --- a/os/include/sys/select.h +++ b/os/include/sys/select.h @@ -143,8 +143,10 @@ extern "C" { /** * @ingroup SELECT_KERNEL - * @brief POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) - * @details SYSTEM CALL API + * @brief synchronous I/O multiplexing + * @details @b #include <sys/select.h> \n + * SYSTEM CALL API \n + * POSIX API (refer to : http://pubs.opengroup.org/onlinepubs/9699919799/) * @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); |