fs: turn some comments into kernel-doc
authorLukas Bulwahn <lukas.bulwahn@gmail.com>
Thu, 4 Feb 2021 18:00:55 +0000 (18:00 +0000)
committerChristian Brauner <christian.brauner@ubuntu.com>
Tue, 23 Mar 2021 10:20:26 +0000 (11:20 +0100)
commit39015399a849843ff8f840b68d16c6ff7c58e0f0
tree376b164bbcfe04078192b0df02a62dcaeb96765e
parent6961fed420146297467efe4bc022458818839a1a
fs: turn some comments into kernel-doc

While reviewing ./include/linux/fs.h, I noticed that three comments can
actually be turned into kernel-doc comments. This allows to check the
consistency between the descriptions and the functions' signatures in
case they may change in the future.

A quick validation with the consistency check:

  ./scripts/kernel-doc -none include/linux/fs.h

currently reports no issues in this file.

Link: https://lore.kernel.org/r/20210204180059.28360-2-lukas.bulwahn@gmail.com
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Acked-by: Christian Brauner <christian.brauner@ubuntu.com>
Signed-off-by: Christian Brauner <christian.brauner@ubuntu.com>
include/linux/fs.h