Modify the indent and coding rule for doxygen
authorjc_.kim <jc_.kim@samsung.com>
Mon, 3 Jul 2017 11:17:10 +0000 (20:17 +0900)
committerjc_.kim <jc_.kim@samsung.com>
Mon, 3 Jul 2017 23:22:38 +0000 (08:22 +0900)
30 files changed:
os/include/assert.h
os/include/crc16.h
os/include/crc32.h
os/include/crc8.h
os/include/debug.h
os/include/dirent.h
os/include/errno.h
os/include/fcntl.h
os/include/fixedmath.h
os/include/inttypes.h
os/include/libgen.h
os/include/mqueue.h
os/include/netdb.h
os/include/netinet/ether.h
os/include/poll.h
os/include/pthread.h
os/include/queue.h
os/include/sched.h
os/include/signal.h
os/include/spawn.h
os/include/stdio.h
os/include/stdlib.h
os/include/string.h
os/include/sys/time.h
os/include/syslog.h
os/include/time.h
os/include/tinyara/clock.h
os/include/tinyara/math.h
os/include/ttrace.h
os/include/unistd.h

index 9c84ffa..47c00f5 100644 (file)
@@ -218,4 +218,6 @@ void up_assert(void) noreturn_function;
 
 #endif                                                 /* __INCLUDE_ASSERT_H */
 
-/** @} *///end of ASSERT_KERNEL
+/**
+ * @}
+ */
index 4f2a39a..5235fbb 100644 (file)
@@ -107,4 +107,6 @@ uint16_t crc16(FAR const uint8_t *src, size_t len);
 
 #endif                                                 /* __INCLUDE_CRC16_H */
 
-/** @} *///end of CRC_KERNEL
+/**
+ * @}
+ */
index 9d37e74..7831c54 100644 (file)
@@ -107,4 +107,6 @@ uint32_t crc32(FAR const uint8_t *src, size_t len);
 
 #endif                                                 /* __INCLUDE_CRC32_H */
 
-/** @} *///end of CRC_KERNEL
+/**
+ * @}
+ */
index 4a01ac8..85ccc47 100644 (file)
@@ -111,4 +111,6 @@ uint8_t crc8(FAR const uint8_t *src, size_t len);
 
 #endif                                                 /* __INCLUDE_CRC8_H */
 
-/** @} *///end of CRC_KERNEL
+/**
+ * @}
+ */
index b6b3b0e..7ebbf4c 100644 (file)
@@ -1115,4 +1115,6 @@ int llvdbg(const char *format, ...);
 }
 #endif
 #endif                                                 /* __INCLUDE_DEBUG_H */
-/** @} *///end of DEBUG_KERNEL
+/**
+ * @}
+ */
index b43128d..f9a4471 100644 (file)
@@ -184,4 +184,5 @@ off_t telldir(FAR DIR *dirp);
 
 #endif                                                 /* __INCLUDE_DIRENT_H */
 /**
- * @} */
+ * @}
+ */
index 4a3b46c..6ac3567 100644 (file)
@@ -466,4 +466,6 @@ int get_errno(void);
 
 #endif                                                 /* __INCLUDE_ERRNO_H */
 
-/** @} */// end of ERRNO_KERNEL
+/**
+ * @}
+ */
index 45397fa..6095a0b 100644 (file)
@@ -215,4 +215,5 @@ int fcntl(int fd, int cmd, ...);
 
 #endif                                                 /* __INCLUDE_FCNTL_H */
 /**
- * @} */
+ * @}
+ */
index b53348b..49a0607 100644 (file)
@@ -242,80 +242,80 @@ extern "C" {
 #ifndef CONFIG_HAVE_LONG_LONG
 /* Multiplication operators */
 /**
-* @brief multiply two b16 numbers
-* @todo
-* @param[in] first operand
-* @param[in] second operand
-* @return the result of two multiplication
-*/
+ * @brief multiply two b16 numbers
+ * @todo
+ * @param[in] first operand
+ * @param[in] second operand
+ * @return the result of two multiplication
+ */
 b16_t b16mulb16(b16_t m1, b16_t m2);
 /**
-* @brief multiply two unsigned b16 numbers
-* @todo
-* @param[in] first operand
-* @param[in] second operand
-* @return the result of two multiplication
-*/
+ * @brief multiply two unsigned b16 numbers
+ * @todo
+ * @param[in] first operand
+ * @param[in] second operand
+ * @return the result of two multiplication
+ */
 ub16_t ub16mulub16(ub16_t m1, ub16_t m2);
 
 /* Square operators */
 /**
-* @brief square b16 number
-* @todo
-* @param[in] first operand
-* @return the result of square
-*/
+ * @brief square b16 number
+ * @todo
+ * @param[in] first operand
+ * @return the result of square
+ */
 b16_t b16sqr(b16_t a);
 /**
-* @brief square unsigned b16 number
-* @todo
-* @param[in] first operand
-* @return the result of square
-*/
+ * @brief square unsigned b16 number
+ * @todo
+ * @param[in] first operand
+ * @return the result of square
+ */
 ub16_t ub16sqr(ub16_t a);
 
 /* Division operators */
 /**
-* @brief divide operation
-* @todo
-* @param[in] a dividend
-* @param[in] a divisor
-* @return the result of divide
-*/
+ * @brief divide operation
+ * @todo
+ * @param[in] a dividend
+ * @param[in] a divisor
+ * @return the result of divide
+ */
 b16_t b16divb16(b16_t num, b16_t denom);
 /**
-* @brief divide operation
-* @todo
-* @param[in] a dividend
-* @param[in] a divisor
-* @return the result of divide
-*/
+ * @brief divide operation
+ * @todo
+ * @param[in] a dividend
+ * @param[in] a divisor
+ * @return the result of divide
+ */
 ub16_t ub16divub16(ub16_t num, ub16_t denom);
 #endif
 
 /* Trigonometric Functions */
 /**
-* @brief Trigonometric sine operation
-* @todo
-* @param[in] a radian value
-* @return the result of sine operation
-*/
+ * @brief Trigonometric sine operation
+ * @todo
+ * @param[in] a radian value
+ * @return the result of sine operation
+ */
 b16_t b16sin(b16_t rad);
 /**
-* @brief Trigonometric cosine operation
-* @todo
-* @param[in] a radian value
-* @return the result of cosine operation
-*/
+ * @brief Trigonometric cosine operation
+ * @todo
+ * @param[in] a radian value
+ * @return the result of cosine operation
+ */
 b16_t b16cos(b16_t rad);
 /**
-* @brief Trigonometric tangent operation
-* @details calculates the arctangent of y/x
-* @todo
-* @param[in] a radian y value
-* @param[in] a radian x value
-* @return the result of tangent operation
-*/
+ * @brief Trigonometric tangent operation
+ * @details calculates the arctangent of y/x
+ * @todo
+ * @param[in] a radian y value
+ * @param[in] a radian x value
+ * @return the result of tangent operation
+ */
 b16_t b16atan2(b16_t y, b16_t x);
 
 #undef EXTERN
@@ -327,4 +327,5 @@ b16_t b16atan2(b16_t y, b16_t x);
 
 /**
  * @endcond
-                 * @} *///end for FIXEDMATH_KERNEL
+ * @}
+ */
index 1c8b2a3..b22a492 100644 (file)
@@ -269,4 +269,5 @@ uintmax_t wcstoumax(const wchar_t *, wchar_t **, int);
 #endif                                                 /* __INCLUDE_INTTYPES_H */
 
 /**
- * @} */
+ * @}
+ */
index 85d6b27..a830c66 100644 (file)
@@ -98,4 +98,6 @@ FAR char *dirname(FAR char *path);
 #endif
 
 #endif                                                 /* __INCLUDE_LIBGEN_H */
-/** @} */// end of LIBGEN_KERNEL
+/**
+ * @}
+ */
index 74e99bd..1cabe12 100644 (file)
@@ -176,4 +176,5 @@ int mq_getattr(mqd_t mqdes, FAR struct mq_attr *mq_stat);
 
 #endif                                                 /* __INCLUDE_MQUEUE_H */
 /**
- * @} */
+ * @}
+ */
index 37101aa..579b73b 100644 (file)
@@ -311,22 +311,22 @@ void endservent(void);
 // @endcond
 
 /**
-* @brief getaddrinfo() is a function that returns information on a particular host name (such as its IP address) and loads up a struct sockaddr.
-* @param[in] host can be either a domain name or NULL
-* @param[in] service can be a port number passed as string or a service name
-* @param[in] hints can be either NULL or an addrinfo structure with the type of service requested
-* @param[in] res is a pointer that points to a new addrinfo structure
-* @return On success, 0 is returned. On failure, a negative value is returned
-* @since Tizen RT v1.0
-*/
+ * @brief getaddrinfo() is a function that returns information on a particular host name (such as its IP address) and loads up a struct sockaddr.
+ * @param[in] host can be either a domain name or NULL
+ * @param[in] service can be a port number passed as string or a service name
+ * @param[in] hints can be either NULL or an addrinfo structure with the type of service requested
+ * @param[in] res is a pointer that points to a new addrinfo structure
+ * @return On success, 0 is returned. On failure, a negative value is returned
+ * @since Tizen RT v1.0
+ */
 int getaddrinfo(const char *host, const char *service, const struct addrinfo *hints, struct addrinfo **res);
 
 /**
-* @brief freeaddrinfo() frees the memory allocated by the getaddrinfo() function.
-* @param[in] ai is the head of the addrinfo list
-* @return void
-* @since Tizen RT v1.0
-*/
+ * @brief freeaddrinfo() frees the memory allocated by the getaddrinfo() function.
+ * @param[in] ai is the head of the addrinfo list
+ * @return void
+ * @since Tizen RT v1.0
+ */
 void freeaddrinfo(FAR struct addrinfo *ai);
 
 /**
@@ -334,7 +334,7 @@ void freeaddrinfo(FAR struct addrinfo *ai);
  * @param[in] *addr host address sending DNS server (e.g., 192.168.0.0)
  * @return On success, hostent, the structure contains hostname of requested IP addresses, returns. On failure, hostname parameters in hostent structure is NULL
  * @since Tizen RT v1.0
-*/
+ */
 FAR struct hostent *gethostbyaddr(FAR const void *addr, socklen_t len, int type);
 
 /**
@@ -342,7 +342,7 @@ FAR struct hostent *gethostbyaddr(FAR const void *addr, socklen_t len, int type)
  * @param[in] *name hostname sending DNS server (e.g., www.samsung.com)
  * @return On success, hostent, the structure contains IP addresses of requested hostname, returns. On failure, IP address parameters in hostent structure is NULL
  * @since Tizen RT v1.0
-*/
+ */
 FAR struct hostent *gethostbyname(FAR const char *name);
 
 #if 0                                                  /* None of these are yet supported */
@@ -382,4 +382,6 @@ int gethostbyname_r(FAR const char *name, FAR struct hostent *host, FAR char *bu
 #endif
 
 #endif                                                 /* __INCLUDE_NETDB_H */
-/** @} */ // end of SOCKET group
+/**
+ * @}
+ */
index 05c9b09..5b1a5de 100644 (file)
@@ -107,4 +107,6 @@ EXTERN int ether_line(const char *line, struct ether_addr *addr, char *hostname)
 #endif
 
 #endif                                                 /*   __INCLUDE_NETINET_ETHER_H */
-/** @} */ // end of SOCKET group
+/**
+ * @}
+ */
index 33682dc..e99c87b 100644 (file)
@@ -174,4 +174,5 @@ int poll(FAR struct pollfd *fds, nfds_t nfds, int timeout);
 
 #endif                                                 /* __INCLUDE_POLL_H */
 /**
- * @} */
+ * @}
+ */
index 32c33c8..de7be7b 100644 (file)
@@ -894,7 +894,8 @@ int pthread_rwlock_unlock(FAR pthread_rwlock_t *lock);
 int pthread_rwlock_wrlock(FAR pthread_rwlock_t *lock);
 
 /**
- * @} */
+ * @}
+ */
 
 #ifdef __cplusplus
 }
index 9141fd5..2ef3d1c 100644 (file)
@@ -254,4 +254,6 @@ FAR dq_entry_t *dq_remfirst(FAR dq_queue_t *queue);
 #endif
 
 #endif                                                 /* __INCLUDE_QUEUE_H_ */
-/** @} */// end of QUEUE_LIBC
+/**
+ * @}
+ */
index 9e87d4c..76a2030 100644 (file)
 #define PTHREAD_KEYS_MAX CONFIG_NPTHREAD_KEYS
 
 /**
- * @} */
+ * @}
+ */
 /********************************************************************************
  * Public Type Definitions
  ********************************************************************************/
index ea2cd62..6b9307b 100644 (file)
@@ -276,7 +276,8 @@ struct sigaction {
 #define sa_sigaction sa_u._sa_sigaction
 
 /**
-* @} */
+ * @}
+ */
 /********************************************************************************
  * Global Variables
  ********************************************************************************/
index ed02510..7be8960 100644 (file)
@@ -329,4 +329,6 @@ void posix_spawnattr_dump(FAR posix_spawnattr_t *attr);
 }
 #endif
 #endif                                                 /* __INCLUDE_SPAWN_H */
-/** @} */// end of SPAWN_LIBC
+/**
+ * @}
+ */
index 7956262..a8fc0c6 100644 (file)
@@ -432,4 +432,6 @@ FAR char *tempnam(FAR const char *dir, FAR const char *pfx);
 #endif
 
 #endif                                                 /* __INCLUDE_STDIO_H */
-/** @} */// end of STDIO_LIBC
+/**
+ * @}
+ */
index 4fcdf11..80faf0c 100644 (file)
@@ -148,7 +148,8 @@ struct lldiv_s {
 
 typedef struct lldiv_s lldiv_t;
 /**
-* @} */
+ * @}
+ */
 
 /****************************************************************************
  * Global Function Prototypes
index 9346bb0..3264279 100644 (file)
@@ -255,4 +255,6 @@ size_t strlcpy(char *__restrict dest, const char *__restrict src, size_t size);
 }
 #endif
 #endif                                                 /* __INCLUDE_STRING_H */
-/** @} */// end of STRING_LIBC
+/**
+ * @}
+ */
index 99f5bfa..e75f270 100644 (file)
@@ -98,4 +98,5 @@ EXTERN int gettimeofday(struct timeval *tv, FAR struct timezone *tz);
 
 #endif                                                 /* __INCLUDE_SYS_TIME_H */
 /**
-                 * @} *///end for TIME_KERNEL
+ * @}
+ */
index 2d4189e..761db06 100644 (file)
@@ -303,4 +303,6 @@ int setlogmask(int mask);
 }
 #endif
 #endif                                                 /* __INCLUDE_SYSLOG_H */
-/** @} */
+/**
+ * @}
+ */
index 15d7b76..da16905 100644 (file)
@@ -197,7 +197,8 @@ struct itimerspec {
 struct sigevent;
 
 /**
- * @} */
+ * @}
+ */
 /********************************************************************************
  * Public Data
  ********************************************************************************/
index 7598c8a..36a48ec 100644 (file)
@@ -377,4 +377,5 @@ int clock_cpuload(int pid, FAR struct cpuload_s *cpuload);
 #endif                                                 /* _INCLUDE_CLOCK_H */
 
 /**
- * @} */ //end for CLOCK_KERNEL
+ * @}
+ */
index 78de5c0..5470387 100644 (file)
@@ -1035,4 +1035,5 @@ long double remquol(long double x, long double y, int *quo);
 #endif                                                 /* CONFIG_LIBM */
 #endif                                                 /* __INCLUDE_MATH_H */
 /**
- *@} */
+ * @}
+ */
index 33ba8ae..4bf31e1 100644 (file)
@@ -77,4 +77,6 @@ int trace_sched(struct tcb_s *prev, struct tcb_s *next);
 #endif
 
 #endif /* __INCLUDE_TTRACE_H */
-/** @} */
+/**
+ * @}
+ */
index c149d9f..7a2dc75 100644 (file)
@@ -286,7 +286,8 @@ ssize_t pread(int fd, FAR void *buf, size_t nbytes, off_t offset);
 ssize_t pwrite(int fd, FAR const void *buf, size_t nbytes, off_t offset);
 
 /**
-                 * @} *///end for UNISTD_KERNEL
+ * @}
+ */
 /* Memory management */
 
 #if defined(CONFIG_ARCH_ADDRENV) && defined(CONFIG_MM_PGALLOC) && \
@@ -396,4 +397,5 @@ int *getoptoptp(void);                      /* unrecognized option character */
 
 #endif                                                 /* __INCLUDE_UNISTD_H */
 /**
- * @} */
+ * @}
+ */