platform/chrome: cros_ec_debugfs: Fix kernel-doc comment first line
authorEnric Balletbo i Serra <enric.balletbo@collabora.com>
Fri, 14 Jun 2019 09:51:24 +0000 (11:51 +0200)
committerEnric Balletbo i Serra <enric.balletbo@collabora.com>
Tue, 18 Jun 2019 08:07:54 +0000 (10:07 +0200)
kernel-doc comments have a prescribed format. To be _particularly_
correct we should also capitalise the brief description and terminate
it with a period.

Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
drivers/platform/chrome/cros_ec_debugfs.c

index 970ba13..cd3fb9c 100644 (file)
@@ -25,7 +25,8 @@
 
 #define CIRC_ADD(idx, size, value)     (((idx) + (value)) & ((size) - 1))
 
-/* struct cros_ec_debugfs - ChromeOS EC debugging information
+/**
+ * struct cros_ec_debugfs - EC debugging information.
  *
  * @ec: EC device this debugfs information belongs to
  * @dir: dentry for debugfs files