linux-kernel - [PATCH] regulator: driver.h: fix kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20211214004444.16932-1-rdunlap@infradead.org>
Date:   Mon, 13 Dec 2021 16:44:44 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Liam Girdwood <lgirdwood@...il.com>,
        Mark Brown <broonie@...nel.org>
Subject: [PATCH] regulator: driver.h: fix kernel-doc warnings

Quieten all kernel-doc warnings in <linux/regulator/driver.h>:

include/linux/regulator/driver.h:262: warning: contents before sections
include/linux/regulator/driver.h:433: warning: Function parameter or member 'n_ramp_values' not described in 'regulator_desc'
include/linux/regulator/driver.h:443: warning: contents before sections

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Liam Girdwood <lgirdwood@...il.com>
Cc: Mark Brown <broonie@...nel.org>
---
Note: in MAINTAINERS, this following line seems to be incorrect:
W:	http://www.slimlogic.co.uk/?p=48

 include/linux/regulator/driver.h |    3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

--- next-2021-1210.orig/include/linux/regulator/driver.h
+++ next-2021-1210/include/linux/regulator/driver.h
@@ -253,7 +253,6 @@ enum regulator_type {
 
 /**
  * struct regulator_desc - Static regulator descriptor
- *
  * Each regulator registered with the core is described with a
  * structure of this type and a struct regulator_config.  This
  * structure contains the non-varying parts of the regulator
@@ -348,6 +347,7 @@ enum regulator_type {
  * @ramp_delay_table:	Table for mapping the regulator ramp-rate values. Values
  *			should be given in units of V/S (uV/uS). See the
  *			regulator_set_ramp_delay_regmap().
+ * @n_ramp_values:	Number of entries in the @ramp_delay_table
  *
  * @enable_time: Time taken for initial enable of regulator (in uS).
  * @off_on_delay: guard time (in uS), before re-enabling a regulator
@@ -434,7 +434,6 @@ struct regulator_desc {
 
 /**
  * struct regulator_config - Dynamic regulator descriptor
- *
  * Each regulator registered with the core is described with a
  * structure of this type and a struct regulator_desc.  This structure
  * contains the runtime variable parts of the regulator description.