Skip to content

Commit e55c0d9

Browse files
xiaoxiang781216pkarashchenko
authored andcommitted
Remove @ tag from all comments
and format the multiple line comments Signed-off-by: Xiang Xiao <[email protected]>
1 parent 9489659 commit e55c0d9

File tree

4 files changed

+64
-75
lines changed

4 files changed

+64
-75
lines changed

examples/nrf24l01_btle/nrf24l01_btle.c

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,9 @@ static inline void crc(uint8_t len, uint8_t * dst)
153153
uint8_t i;
154154
uint8_t * buf = (uint8_t *)&buffer;
155155

156-
/**
157-
* initialize 24-bit shift register in "wire bit order"
156+
/* initialize 24-bit shift register in "wire bit order"
158157
* dst[0] = bits 23-16, dst[1] = bits 15-8, dst[2] = bits 7-0.
159-
**/
158+
*/
160159

161160
dst[0] = 0xaa;
162161
dst[1] = 0xaa;
@@ -167,27 +166,24 @@ static inline void crc(uint8_t len, uint8_t * dst)
167166
uint8_t d = *(buf++);
168167
for (i = 1; i; i <<= 1, d >>= 1)
169168
{
170-
/**
171-
* save bit 23 (highest-value),
169+
/* save bit 23 (highest-value),
172170
* left-shift the entire register by one
173-
**/
171+
*/
174172

175173
uint8_t t = dst[0] & 0x01; dst[0] >>= 1;
176174
if (dst[1] & 0x01) dst[0] |= 0x80; dst[1] >>= 1;
177175
if (dst[2] & 0x01) dst[1] |= 0x80; dst[2] >>= 1;
178176

179-
/**
180-
* if the bit just shifted out (former bit 23) and the incoming
177+
/* if the bit just shifted out (former bit 23) and the incoming
181178
* data bit are not equal (i.e. bit_out ^ bit_in == 1) => toggle
182179
* tap bits
183180
*/
184181

185182
if (t != (d & 1))
186183
{
187-
/**
188-
* toggle register tap bits (=XOR with 1)
184+
/* toggle register tap bits (=XOR with 1)
189185
* according to CRC polynom
190-
**/
186+
*/
191187

192188
/* 0b11011010 inv. = 0b01011011 ^= x^6+x^4+x^3+x+1 */
193189

include/netutils/xtables.h

Lines changed: 46 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -37,31 +37,30 @@
3737

3838
#define XTABLES_VERSION_CODE 12
3939

40-
/**
41-
* Select the format the input has to conform to, as well as the target type
40+
/* Select the format the input has to conform to, as well as the target type
4241
* (area pointed to with XTOPT_POINTER). Note that the storing is not always
43-
* uniform. @cb->val will be populated with as much as there is space, i.e.
42+
* uniform. cb->val will be populated with as much as there is space, i.e.
4443
* exactly 2 items for ranges, but the target area can receive more values
45-
* (e.g. in case of ranges), or less values (e.g. %XTTYPE_HOSTMASK).
44+
* (e.g. in case of ranges), or less values (e.g. XTTYPE_HOSTMASK).
4645
*
47-
* %XTTYPE_NONE: option takes no argument
48-
* %XTTYPE_UINT*: standard integer
49-
* %XTTYPE_UINT*RC: colon-separated range of standard integers
50-
* %XTTYPE_DOUBLE: double-precision floating point number
51-
* %XTTYPE_STRING: arbitrary string
52-
* %XTTYPE_TOSMASK: 8-bit TOS value with optional mask
53-
* %XTTYPE_MARKMASK32: 32-bit mark with optional mask
54-
* %XTTYPE_SYSLOGLEVEL: syslog level by name or number
55-
* %XTTYPE_HOST: one host or address (ptr: union nf_inet_addr)
56-
* %XTTYPE_HOSTMASK: one host or address, with an optional prefix length
46+
* XTTYPE_NONE: option takes no argument
47+
* XTTYPE_UINT*: standard integer
48+
* XTTYPE_UINT*RC: colon-separated range of standard integers
49+
* XTTYPE_DOUBLE: double-precision floating point number
50+
* XTTYPE_STRING: arbitrary string
51+
* XTTYPE_TOSMASK: 8-bit TOS value with optional mask
52+
* XTTYPE_MARKMASK32: 32-bit mark with optional mask
53+
* XTTYPE_SYSLOGLEVEL: syslog level by name or number
54+
* XTTYPE_HOST: one host or address (ptr: union nf_inet_addr)
55+
* XTTYPE_HOSTMASK: one host or address, with an optional prefix length
5756
* ptr: union nf_inet_addr; only host portion is stored
58-
* %XTTYPE_PROTOCOL: protocol number/name from /etc/protocols ptr: uint8_t
59-
* %XTTYPE_PORT: 16-bit port name or number (supports %XTOPT_NBO)
60-
* %XTTYPE_PORTRC: colon-separated port range (names acceptable),
61-
* (supports %XTOPT_NBO)
62-
* %XTTYPE_PLEN: prefix length
63-
* %XTTYPE_PLENMASK: prefix length (ptr: union nf_inet_addr)
64-
* %XTTYPE_ETHERMAC: Ethernet MAC address in hex form
57+
* XTTYPE_PROTOCOL: protocol number/name from /etc/protocols ptr: uint8_t
58+
* XTTYPE_PORT: 16-bit port name or number (supports XTOPT_NBO)
59+
* XTTYPE_PORTRC: colon-separated port range (names acceptable),
60+
* (supports XTOPT_NBO)
61+
* XTTYPE_PLEN: prefix length
62+
* XTTYPE_PLENMASK: prefix length (ptr: union nf_inet_addr)
63+
* XTTYPE_ETHERMAC: Ethernet MAC address in hex form
6564
*/
6665

6766
enum xt_option_type
@@ -127,17 +126,16 @@ struct xtables_globals
127126
int (*compat_rev)(FAR const char *name, uint8_t rev, int opt);
128127
};
129128

130-
/**
131-
* @name: name of option
132-
* @type: type of input and validation method, see %XTTYPE_*
133-
* @id: unique number (within extension) for option, 0-31
134-
* @excl: bitmask of flags that cannot be used with this option
135-
* @also: bitmask of flags that must be used with this option
136-
* @flags: bitmask of option flags, see %XTOPT_*
137-
* @ptroff: offset into private structure for member
138-
* @size: size of the item pointed to by @ptroff; this is a safeguard
139-
* @min: lowest allowed value (for singular integral types)
140-
* @max: highest allowed value (for singular integral types)
129+
/* name: name of option
130+
* type: type of input and validation method, see XTTYPE_*
131+
* id: unique number (within extension) for option, 0-31
132+
* excl: bitmask of flags that cannot be used with this option
133+
* also: bitmask of flags that must be used with this option
134+
* flags: bitmask of option flags, see XTOPT_*
135+
* ptroff: offset into private structure for member
136+
* size: size of the item pointed to by ptroff; this is a safeguard
137+
* min: lowest allowed value (for singular integral types)
138+
* max: highest allowed value (for singular integral types)
141139
*/
142140

143141
struct xt_option_entry
@@ -163,12 +161,11 @@ struct xt_xlate_tg_params
163161
bool escape_quotes;
164162
};
165163

166-
/**
167-
* @ext_name: name of extension currently being processed
168-
* @data: per-extension (kernel) data block
169-
* @udata: per-extension private scratch area
170-
* (cf. xtables_{match,target}->udata_size)
171-
* @xflags: options of the extension that have been used
164+
/* ext_name: name of extension currently being processed
165+
* data: per-extension (kernel) data block
166+
* udata: per-extension private scratch area
167+
* (cf. xtables_{match,target}->udata_size)
168+
* xflags: options of the extension that have been used
172169
*/
173170

174171
struct xt_fcheck_call
@@ -187,17 +184,16 @@ struct xt_xlate_mt_params
187184
bool escape_quotes;
188185
};
189186

190-
/**
191-
* @arg: input from command line
192-
* @ext_name: name of extension currently being processed
193-
* @entry: current option being processed
194-
* @data: per-extension kernel data block
195-
* @xflags: options of the extension that have been used
196-
* @invert: whether option was used with !
197-
* @nvals: number of results in uXX_multi
198-
* @val: parsed result
199-
* @udata: per-extension private scratch area
200-
* (cf. xtables_{match,target}->udata_size)
187+
/* arg: input from command line
188+
* ext_name: name of extension currently being processed
189+
* entry: current option being processed
190+
* data: per-extension kernel data block
191+
* xflags: options of the extension that have been used
192+
* invert: whether option was used with !
193+
* nvals: number of results in uXX_multi
194+
* val: parsed result
195+
* udata: per-extension private scratch area
196+
* (cf. xtables_{match,target}->udata_size)
201197
*/
202198

203199
struct xt_option_call
@@ -353,8 +349,7 @@ struct xtables_match
353349

354350
struct xtables_target
355351
{
356-
/**
357-
* ABI/API version this module requires. Must be first member,
352+
/* ABI/API version this module requires. Must be first member,
358353
* as the rest of this struct may be subject to ABI changes.
359354
*/
360355

system/uorb/uORB/uORB.h

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -112,40 +112,39 @@ typedef uint64_t orb_abstime;
112112

113113
#define uorbinfo_raw(fmt, ...) syslog(LOG_INFO, fmt "\n", ##__VA_ARGS__)
114114

115-
/**
116-
* Generates a pointer to the uORB metadata structure for
115+
/* Generates a pointer to the uORB metadata structure for
117116
* a given topic.
118117
*
119118
* The topic must have been declared previously in scope
120119
* with ORB_DECLARE().
121120
*
122-
* @param name The name of the topic.
121+
* name The name of the topic.
123122
*/
123+
124124
#define ORB_ID(name) &g_orb_##name
125125

126-
/**
127-
* Declare the uORB metadata for a topic (used by code generators).
126+
/* Declare the uORB metadata for a topic (used by code generators).
128127
*
129-
* @param name The name of the topic.
128+
* name The name of the topic.
130129
*/
130+
131131
#if defined(__cplusplus)
132132
# define ORB_DECLARE(name) extern "C" const struct orb_metadata g_orb_##name
133133
#else
134134
# define ORB_DECLARE(name) extern const struct orb_metadata g_orb_##name
135135
#endif
136136

137-
/**
138-
* Define (instantiate) the uORB metadata for a topic.
137+
/* Define (instantiate) the uORB metadata for a topic.
139138
*
140139
* The uORB metadata is used to help ensure that updates and
141140
* copies are accessing the right data.
142141
*
143142
* Note that there must be no more than one instance of this macro
144143
* for each topic.
145144
*
146-
* @param name The name of the topic.
147-
* @param struct The structure the topic provides.
148-
* @param cb The function pointer of output topic message.
145+
* name The name of the topic.
146+
* struct The structure the topic provides.
147+
* cb The function pointer of output topic message.
149148
*/
150149
#ifdef CONFIG_DEBUG_UORB
151150
#define ORB_DEFINE(name, structure, cb) \

testing/monkey/monkey_utils.c

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,7 @@ int monkey_map(int x, int min_in, int max_in, int min_out, int max_out)
179179
return min_out;
180180
}
181181

182-
/**
183-
* The equation should be:
182+
/* The equation should be:
184183
* ((x - min_in) * delta_out) / delta in) + min_out
185184
* To avoid rounding error reorder the operations:
186185
* (x - min_in) * (delta_out / delta_min) + min_out

0 commit comments

Comments
 (0)