power: supply: ab8500_chargalg: improve kernel-doc

Correct "bad line" warnings and add descriptions for missing entries
to avoid these warnings:

ab8500_chargalg.c:173: warning: bad line:  is set
ab8500_chargalg.c:179: warning: bad line:  increased
ab8500_chargalg.c:247: warning: Function parameter or struct member
 't_hyst_norm' not described in 'ab8500_chargalg'
ab8500_chargalg.c:247: warning: Function parameter or struct member
 't_hyst_lowhigh' not described in 'ab8500_chargalg'
ab8500_chargalg.c:247: warning: Function parameter or struct member
 'ccm' not described in 'ab8500_chargalg'
ab8500_chargalg.c:247: warning: Function parameter or struct member
 'ac_chg' not described in 'ab8500_chargalg'
ab8500_chargalg.c:247: warning: Function parameter or struct member
 'usb_chg' not described in 'ab8500_chargalg'
ab8500_chargalg.c:308: warning: Function parameter or struct member
 'state' not described in 'ab8500_chargalg_state_to'
ab8500_chargalg.c:773: warning: Function parameter or struct member
 'di' not described in 'ab8500_chargalg_chg_curr_maxim'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Link: https://patch.msgid.link/20251111060009.1959425-1-rdunlap@infradead.org
Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>

diff --git a/drivers/power/supply/ab8500_chargalg.c b/drivers/power/supply/ab8500_chargalg.c
index dc6c8b0dd1cfdb6c42a633c3355b1614c5058c10..d2b9880b07707f442a616bc81959197a207fc889 100644 (file)
--- a/drivers/power/supply/ab8500_chargalg.c
+++ b/drivers/power/supply/ab8500_chargalg.c
@@ -170,13 +170,13 @@ struct ab8500_chargalg_events {
  * @original_iset_ua:  the non optimized/maximised charger current
  * @current_iset_ua:   the charging current used at this moment
  * @condition_cnt:     number of iterations needed before a new charger current
-                       is set
+ *                     is set
  * @max_current_ua:    maximum charger current
  * @wait_cnt:          to avoid too fast current step down in case of charger
  *                     voltage collapse, we insert this delay between step
  *                     down
  * @level:             tells in how many steps the charging current has been
-                       increased
+ *                     increased
  */
 struct ab8500_charge_curr_maximization {
        int original_iset_ua;
@@ -199,18 +199,20 @@ enum maxim_ret {
  * @charge_status:     battery operating status
  * @eoc_cnt:           counter used to determine end-of_charge
  * @maintenance_chg:   indicate if maintenance charge is active
- * @t_hyst_norm                temperature hysteresis when the temperature has been
+ * @t_hyst_norm:       temperature hysteresis when the temperature has been
  *                     over or under normal limits
- * @t_hyst_lowhigh     temperature hysteresis when the temperature has been
+ * @t_hyst_lowhigh:    temperature hysteresis when the temperature has been
  *                     over or under the high or low limits
  * @charge_state:      current state of the charging algorithm
- * @ccm                        charging current maximization parameters
+ * @ccm:               charging current maximization parameters
  * @chg_info:          information about connected charger types
  * @batt_data:         data of the battery
  * @bm:                Platform specific battery management information
  * @parent:            pointer to the struct ab8500
  * @chargalg_psy:      structure that holds the battery properties exposed by
  *                     the charging algorithm
+ * @ac_chg:            AC charger power supply
+ * @usb_chg:           USB charger power supply
  * @events:            structure for information about events triggered
  * @chargalg_wq:               work queue for running the charging algorithm
  * @chargalg_periodic_work:    work to run the charging algorithm periodically
@@ -300,6 +302,7 @@ ab8500_chargalg_maintenance_timer_expired(struct hrtimer *timer)
 /**
  * ab8500_chargalg_state_to() - Change charge state
  * @di:                pointer to the ab8500_chargalg structure
+ * @state:     new charge algorithm state
  *
  * This function gets called when a charge state change should occur
  */
@@ -763,7 +766,7 @@ static void init_maxim_chg_curr(struct ab8500_chargalg *di)
 /**
  * ab8500_chargalg_chg_curr_maxim - increases the charger current to
  *                     compensate for the system load
- * @di         pointer to the ab8500_chargalg structure
+ * @di:                pointer to the ab8500_chargalg structure
  *
  * This maximization function is used to raise the charger current to get the
  * battery current as close to the optimal value as possible. The battery