Skip to content

Commit f7e46d4

Browse files
AmitVadhavana14gregkh
authored andcommitted
slimbus: Fix struct and documentation alignment in stream.c
The placement of the `segdist_codes` array documentation was corrected to conform with kernel documentation guidelines. The `@segdist_codes` was placed incorrectly within the struct `segdist_code` documentation block, which led to a potential misinterpretation of the code structure. The `segdist_codes` array documentation was moved outside the struct block, and a separate comment block was provided for it. This change ensures that clarity and proper alignment with kernel documentation standards are maintained. A kernel-doc warning was addressed: ./drivers/slimbus/stream.c:49: warning: Excess struct member 'segdist_codes' description in 'segdist_code' Signed-off-by: Amit Vadhavana <[email protected]> Reviewed-by: Ricardo B. Marliere <[email protected]> Signed-off-by: Srinivas Kandagatla <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent c66c0e7 commit f7e46d4

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

drivers/slimbus/stream.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,17 @@
1818
* and the first slot of the next consecutive Segment.
1919
* @segdist_code: Segment Distribution Code SD[11:0]
2020
* @seg_offset_mask: Segment offset mask in SD[11:0]
21-
* @segdist_codes: List of all possible Segmet Distribution codes.
2221
*/
23-
static const struct segdist_code {
22+
struct segdist_code {
2423
int ratem;
2524
int seg_interval;
2625
int segdist_code;
2726
u32 seg_offset_mask;
2827

29-
} segdist_codes[] = {
28+
};
29+
30+
/* segdist_codes - List of all possible Segment Distribution codes. */
31+
static const struct segdist_code segdist_codes[] = {
3032
{1, 1536, 0x200, 0xdff},
3133
{2, 768, 0x100, 0xcff},
3234
{4, 384, 0x080, 0xc7f},

0 commit comments

Comments
 (0)