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: a72232eabdfc ("cgroup: Add misc cgroup controller")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: cgroups@vger.kernel.org
Signed-off-by: Tejun Heo <tj@kernel.org>

diff --git a/include/linux/misc_cgroup.h b/include/linux/misc_cgroup.h
index e799b1f8d05bb37745af7cc3e31f2b0f8a5f441c..d70eab2501ee031efb8d4c18b1325461f1f675dd 100644 (file)
--- a/include/linux/misc_cgroup.h
+++ b/include/linux/misc_cgroup.h
@@ -9,15 +9,16 @@
 #define _MISC_CGROUP_H_
 
 /**
- * Types of misc cgroup entries supported by the host.
+ * enum misc_res_type - Types of misc cgroup entries supported by the host.
  */
 enum misc_res_type {
 #ifdef CONFIG_KVM_AMD_SEV
-       /* AMD SEV ASIDs resource */
+       /** @MISC_CG_RES_SEV: AMD SEV ASIDs resource */
        MISC_CG_RES_SEV,
-       /* AMD SEV-ES ASIDs resource */
+       /** @MISC_CG_RES_SEV_ES: AMD SEV-ES ASIDs resource */
        MISC_CG_RES_SEV_ES,
 #endif
+       /** @MISC_CG_RES_TYPES: count of enum misc_res_type constants */
        MISC_CG_RES_TYPES
 };