Skip to content

Commit 7a44796

Browse files
rddunlaphtejun
authored andcommitted
cgroup_misc: add kernel-doc comments for enum misc_res_type
Fully document enum misc_res_type with kernel-doc comments to prevent kernel-doc warnings: misc_cgroup.h:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Types of misc cgroup entries supported by the host. misc_cgroup.h:12: warning: missing initial short description on line: * Types of misc cgroup entries supported by the host. Fixes: a72232e ("cgroup: Add misc cgroup controller") Signed-off-by: Randy Dunlap <[email protected]> Cc: [email protected] Signed-off-by: Tejun Heo <[email protected]>
1 parent 1c0be3f commit 7a44796

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

include/linux/misc_cgroup.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,16 @@
99
#define _MISC_CGROUP_H_
1010

1111
/**
12-
* Types of misc cgroup entries supported by the host.
12+
* enum misc_res_type - Types of misc cgroup entries supported by the host.
1313
*/
1414
enum misc_res_type {
1515
#ifdef CONFIG_KVM_AMD_SEV
16-
/* AMD SEV ASIDs resource */
16+
/** @MISC_CG_RES_SEV: AMD SEV ASIDs resource */
1717
MISC_CG_RES_SEV,
18-
/* AMD SEV-ES ASIDs resource */
18+
/** @MISC_CG_RES_SEV_ES: AMD SEV-ES ASIDs resource */
1919
MISC_CG_RES_SEV_ES,
2020
#endif
21+
/** @MISC_CG_RES_TYPES: count of enum misc_res_type constants */
2122
MISC_CG_RES_TYPES
2223
};
2324

0 commit comments

Comments
 (0)