This is an automated email from the ASF dual-hosted git repository.
pkarashchenko pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx-apps.git
The following commit(s) were added to refs/heads/master by this push:
new e55c0d9aa Remove @ tag from all comments
e55c0d9aa is described below
commit e55c0d9aa5f4ae257418f7c7dacbbbe3bd4a2420
Author: Xiang Xiao <xiaoxi...@xiaomi.com>
AuthorDate: Sun Dec 10 22:56:47 2023 +0800
Remove @ tag from all comments
and format the multiple line comments
Signed-off-by: Xiang Xiao <xiaoxi...@xiaomi.com>
---
examples/nrf24l01_btle/nrf24l01_btle.c | 18 +++----
include/netutils/xtables.h | 97 ++++++++++++++++------------------
system/uorb/uORB/uORB.h | 21 ++++----
testing/monkey/monkey_utils.c | 3 +-
4 files changed, 64 insertions(+), 75 deletions(-)
diff --git a/examples/nrf24l01_btle/nrf24l01_btle.c
b/examples/nrf24l01_btle/nrf24l01_btle.c
index 3fe7f7827..33db52f97 100644
--- a/examples/nrf24l01_btle/nrf24l01_btle.c
+++ b/examples/nrf24l01_btle/nrf24l01_btle.c
@@ -153,10 +153,9 @@ static inline void crc(uint8_t len, uint8_t * dst)
uint8_t i;
uint8_t * buf = (uint8_t *)&buffer;
- /**
- * initialize 24-bit shift register in "wire bit order"
+ /* initialize 24-bit shift register in "wire bit order"
* dst[0] = bits 23-16, dst[1] = bits 15-8, dst[2] = bits 7-0.
- **/
+ */
dst[0] = 0xaa;
dst[1] = 0xaa;
@@ -167,27 +166,24 @@ static inline void crc(uint8_t len, uint8_t * dst)
uint8_t d = *(buf++);
for (i = 1; i; i <<= 1, d >>= 1)
{
- /**
- * save bit 23 (highest-value),
+ /* save bit 23 (highest-value),
* left-shift the entire register by one
- **/
+ */
uint8_t t = dst[0] & 0x01; dst[0] >>= 1;
if (dst[1] & 0x01) dst[0] |= 0x80; dst[1] >>= 1;
if (dst[2] & 0x01) dst[1] |= 0x80; dst[2] >>= 1;
- /**
- * if the bit just shifted out (former bit 23) and the incoming
+ /* if the bit just shifted out (former bit 23) and the incoming
* data bit are not equal (i.e. bit_out ^ bit_in == 1) => toggle
* tap bits
*/
if (t != (d & 1))
{
- /**
- * toggle register tap bits (=XOR with 1)
+ /* toggle register tap bits (=XOR with 1)
* according to CRC polynom
- **/
+ */
/* 0b11011010 inv. = 0b01011011 ^= x^6+x^4+x^3+x+1 */
diff --git a/include/netutils/xtables.h b/include/netutils/xtables.h
index 517239caf..d2370e804 100644
--- a/include/netutils/xtables.h
+++ b/include/netutils/xtables.h
@@ -37,31 +37,30 @@
#define XTABLES_VERSION_CODE 12
-/**
- * Select the format the input has to conform to, as well as the target type
+/* Select the format the input has to conform to, as well as the target type
* (area pointed to with XTOPT_POINTER). Note that the storing is not always
- * uniform. @cb->val will be populated with as much as there is space, i.e.
+ * uniform. cb->val will be populated with as much as there is space, i.e.
* exactly 2 items for ranges, but the target area can receive more values
- * (e.g. in case of ranges), or less values (e.g. %XTTYPE_HOSTMASK).
+ * (e.g. in case of ranges), or less values (e.g. XTTYPE_HOSTMASK).
*
- * %XTTYPE_NONE: option takes no argument
- * %XTTYPE_UINT*: standard integer
- * %XTTYPE_UINT*RC: colon-separated range of standard integers
- * %XTTYPE_DOUBLE: double-precision floating point number
- * %XTTYPE_STRING: arbitrary string
- * %XTTYPE_TOSMASK: 8-bit TOS value with optional mask
- * %XTTYPE_MARKMASK32: 32-bit mark with optional mask
- * %XTTYPE_SYSLOGLEVEL: syslog level by name or number
- * %XTTYPE_HOST: one host or address (ptr: union nf_inet_addr)
- * %XTTYPE_HOSTMASK: one host or address, with an optional prefix length
+ * XTTYPE_NONE: option takes no argument
+ * XTTYPE_UINT*: standard integer
+ * XTTYPE_UINT*RC: colon-separated range of standard integers
+ * XTTYPE_DOUBLE: double-precision floating point number
+ * XTTYPE_STRING: arbitrary string
+ * XTTYPE_TOSMASK: 8-bit TOS value with optional mask
+ * XTTYPE_MARKMASK32: 32-bit mark with optional mask
+ * XTTYPE_SYSLOGLEVEL: syslog level by name or number
+ * XTTYPE_HOST: one host or address (ptr: union nf_inet_addr)
+ * XTTYPE_HOSTMASK: one host or address, with an optional prefix length
* ptr: union nf_inet_addr; only host portion is stored
- * %XTTYPE_PROTOCOL: protocol number/name from /etc/protocols ptr: uint8_t
- * %XTTYPE_PORT: 16-bit port name or number (supports %XTOPT_NBO)
- * %XTTYPE_PORTRC: colon-separated port range (names acceptable),
- * (supports %XTOPT_NBO)
- * %XTTYPE_PLEN: prefix length
- * %XTTYPE_PLENMASK: prefix length (ptr: union nf_inet_addr)
- * %XTTYPE_ETHERMAC: Ethernet MAC address in hex form
+ * XTTYPE_PROTOCOL: protocol number/name from /etc/protocols ptr: uint8_t
+ * XTTYPE_PORT: 16-bit port name or number (supports XTOPT_NBO)
+ * XTTYPE_PORTRC: colon-separated port range (names acceptable),
+ * (supports XTOPT_NBO)
+ * XTTYPE_PLEN: prefix length
+ * XTTYPE_PLENMASK: prefix length (ptr: union nf_inet_addr)
+ * XTTYPE_ETHERMAC: Ethernet MAC address in hex form
*/
enum xt_option_type
@@ -127,17 +126,16 @@ struct xtables_globals
int (*compat_rev)(FAR const char *name, uint8_t rev, int opt);
};
-/**
- * @name: name of option
- * @type: type of input and validation method, see %XTTYPE_*
- * @id: unique number (within extension) for option, 0-31
- * @excl: bitmask of flags that cannot be used with this option
- * @also: bitmask of flags that must be used with this option
- * @flags: bitmask of option flags, see %XTOPT_*
- * @ptroff: offset into private structure for member
- * @size: size of the item pointed to by @ptroff; this is a safeguard
- * @min: lowest allowed value (for singular integral types)
- * @max: highest allowed value (for singular integral types)
+/* name: name of option
+ * type: type of input and validation method, see XTTYPE_*
+ * id: unique number (within extension) for option, 0-31
+ * excl: bitmask of flags that cannot be used with this option
+ * also: bitmask of flags that must be used with this option
+ * flags: bitmask of option flags, see XTOPT_*
+ * ptroff: offset into private structure for member
+ * size: size of the item pointed to by ptroff; this is a safeguard
+ * min: lowest allowed value (for singular integral types)
+ * max: highest allowed value (for singular integral types)
*/
struct xt_option_entry
@@ -163,12 +161,11 @@ struct xt_xlate_tg_params
bool escape_quotes;
};
-/**
- * @ext_name: name of extension currently being processed
- * @data: per-extension (kernel) data block
- * @udata: per-extension private scratch area
- * (cf. xtables_{match,target}->udata_size)
- * @xflags: options of the extension that have been used
+/* ext_name: name of extension currently being processed
+ * data: per-extension (kernel) data block
+ * udata: per-extension private scratch area
+ * (cf. xtables_{match,target}->udata_size)
+ * xflags: options of the extension that have been used
*/
struct xt_fcheck_call
@@ -187,17 +184,16 @@ struct xt_xlate_mt_params
bool escape_quotes;
};
-/**
- * @arg: input from command line
- * @ext_name: name of extension currently being processed
- * @entry: current option being processed
- * @data: per-extension kernel data block
- * @xflags: options of the extension that have been used
- * @invert: whether option was used with !
- * @nvals: number of results in uXX_multi
- * @val: parsed result
- * @udata: per-extension private scratch area
- * (cf. xtables_{match,target}->udata_size)
+/* arg: input from command line
+ * ext_name: name of extension currently being processed
+ * entry: current option being processed
+ * data: per-extension kernel data block
+ * xflags: options of the extension that have been used
+ * invert: whether option was used with !
+ * nvals: number of results in uXX_multi
+ * val: parsed result
+ * udata: per-extension private scratch area
+ * (cf. xtables_{match,target}->udata_size)
*/
struct xt_option_call
@@ -353,8 +349,7 @@ struct xtables_match
struct xtables_target
{
- /**
- * ABI/API version this module requires. Must be first member,
+ /* ABI/API version this module requires. Must be first member,
* as the rest of this struct may be subject to ABI changes.
*/
diff --git a/system/uorb/uORB/uORB.h b/system/uorb/uORB/uORB.h
index 047c55def..d134393c1 100644
--- a/system/uorb/uORB/uORB.h
+++ b/system/uorb/uORB/uORB.h
@@ -112,30 +112,29 @@ typedef uint64_t orb_abstime;
#define uorbinfo_raw(fmt, ...) syslog(LOG_INFO, fmt "\n", ##__VA_ARGS__)
-/**
- * Generates a pointer to the uORB metadata structure for
+/* Generates a pointer to the uORB metadata structure for
* a given topic.
*
* The topic must have been declared previously in scope
* with ORB_DECLARE().
*
- * @param name The name of the topic.
+ * name The name of the topic.
*/
+
#define ORB_ID(name) &g_orb_##name
-/**
- * Declare the uORB metadata for a topic (used by code generators).
+/* Declare the uORB metadata for a topic (used by code generators).
*
- * @param name The name of the topic.
+ * name The name of the topic.
*/
+
#if defined(__cplusplus)
# define ORB_DECLARE(name) extern "C" const struct orb_metadata g_orb_##name
#else
# define ORB_DECLARE(name) extern const struct orb_metadata g_orb_##name
#endif
-/**
- * Define (instantiate) the uORB metadata for a topic.
+/* Define (instantiate) the uORB metadata for a topic.
*
* The uORB metadata is used to help ensure that updates and
* copies are accessing the right data.
@@ -143,9 +142,9 @@ typedef uint64_t orb_abstime;
* Note that there must be no more than one instance of this macro
* for each topic.
*
- * @param name The name of the topic.
- * @param struct The structure the topic provides.
- * @param cb The function pointer of output topic message.
+ * name The name of the topic.
+ * struct The structure the topic provides.
+ * cb The function pointer of output topic message.
*/
#ifdef CONFIG_DEBUG_UORB
#define ORB_DEFINE(name, structure, cb) \
diff --git a/testing/monkey/monkey_utils.c b/testing/monkey/monkey_utils.c
index 21dae0296..9e322c756 100644
--- a/testing/monkey/monkey_utils.c
+++ b/testing/monkey/monkey_utils.c
@@ -179,8 +179,7 @@ int monkey_map(int x, int min_in, int max_in, int min_out,
int max_out)
return min_out;
}
- /**
- * The equation should be:
+ /* The equation should be:
* ((x - min_in) * delta_out) / delta in) + min_out
* To avoid rounding error reorder the operations:
* (x - min_in) * (delta_out / delta_min) + min_out
