]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/commit
regmap: Fixup the kernel-doc comments on functions/structures
authorCharles Keepax <ckeepax@opensource.wolfsonmicro.com>
Thu, 12 Jan 2017 11:17:39 +0000 (11:17 +0000)
committerMark Brown <broonie@kernel.org>
Thu, 12 Jan 2017 17:22:48 +0000 (17:22 +0000)
commit2cf8e2dfdf88363476f23bc600745250b94dbbed
treec739f2ac94ffc757e4b52753eef09e65c841a39c
parentdaaadbf07433b15c452b2ff411a293b2ccd98e03
regmap: Fixup the kernel-doc comments on functions/structures

Most of the kernel-doc comments in regmap don't actually generate
correctly. This patch fixes up a few common issues, corrects some typos
and adds some missing argument descriptions.

The most common issues being using a : after the function name which
causes the short description to not render correctly and not separating
the long and short descriptions of the function. There are quite a few
instances of arguments not being described or given the wrong name as
well.

This patch doesn't fixup functions/structures that are currently missing
descriptions.

Signed-off-by: Charles Keepax <ckeepax@opensource.wolfsonmicro.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/base/regmap/regcache.c
drivers/base/regmap/regmap-irq.c
drivers/base/regmap/regmap.c
include/linux/regmap.h