From patchwork Fri Dec 22 06:19:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 182553 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp876131dyi; Thu, 21 Dec 2023 22:20:10 -0800 (PST) X-Google-Smtp-Source: AGHT+IEpqOHTmr3fLDlYyh+v6TlE9RBx1Nsh93zXA1f0USkX1k6Tu9ehm78DfIinF74WZgCJqhiS X-Received: by 2002:a05:6e02:b4a:b0:35f:d227:b328 with SMTP id f10-20020a056e020b4a00b0035fd227b328mr999731ilu.0.1703226010382; Thu, 21 Dec 2023 22:20:10 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703226010; cv=none; d=google.com; s=arc-20160816; b=wqGAu3CEZu6gJ9N7VrjIqNnNR3zt2xAwpc/fS5huhT8usZ8mMma2JurUVBRrW0OL3Z beCBxLOxggbR166SeaOrzQbE9cSMeY7qVeq3ISWvukw1f4GCM/aess8/jUNmfeU2aUbh pNJKLzH7ESJY/hMImZAiAmuEkiChfGRT8WYUvbM1drJLzRAeR04RPkibmHcXP+OHFQHb FqqMTkxOwLuKlxUeZUoEKMZ21oGSJaF7gvcgdEOIht3K8qgc0gPvoQEyAipo+xL9cJuC TgeMMSQUHVcExuw8McMTbKDvIJntUjw+19NNVr3pL1U8TnTUIN/IRpILZGCBWTFZEUqP P7hw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=vcXjkACtt3w1L/iqeM+O5LdUiTqdAb5DknSdUDcSKoc=; fh=5ycxXjUVphCEZb2zKgRkm3tKjHkjVeyF2npG8R7OrbE=; b=CZPOJAkW4hSiiTORr1uSQ6lvT90BjnV1T23AVj9Qq7vtr6iK1+JDagSeOOevO1Qfzx p1Gwi8sIahZ4qbVUtS//zZ8K2N71xAVpu6rCQa4ISKHydRnUh6VUC6BUO/7OVveT6i6W EMGhZG5WRC1wJ3eJjjT1y8xUwcSOyzCWDlZuFRclGj+On/vdGCghJ0SOuHt1jW14UvBL h8HFSZlI0b0sNFhHnvmEyrQlSdoJoZ+PZNOFEaagKuyVzEj/qTqHStPwK0V1Fu2+g5P8 8xI7cUdh2M8v+cPFnp+2M8lhKvkoFZT7JWnoD7d9OlqHjhwHKMV4s0I0n4tP+HjzxtB7 rwog== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=SgSmDTZc; spf=pass (google.com: domain of linux-kernel+bounces-9397-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9397-ouuuleilei=gmail.com@vger.kernel.org" Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [2604:1380:45e3:2400::1]) by mx.google.com with ESMTPS id bx19-20020a056a02051300b005cd8bd4f71dsi2852716pgb.710.2023.12.21.22.20.10 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Dec 2023 22:20:10 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-9397-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=SgSmDTZc; spf=pass (google.com: domain of linux-kernel+bounces-9397-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-9397-ouuuleilei=gmail.com@vger.kernel.org" Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sv.mirrors.kernel.org (Postfix) with ESMTPS id 25B4B2854DA for ; Fri, 22 Dec 2023 06:20:10 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 51D4A9455; Fri, 22 Dec 2023 06:19:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="SgSmDTZc" X-Original-To: linux-kernel@vger.kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A2192DDAB; Fri, 22 Dec 2023 06:19:32 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=vcXjkACtt3w1L/iqeM+O5LdUiTqdAb5DknSdUDcSKoc=; b=SgSmDTZcnoh8EPslL2Q+3FamC+ YeOAMA8kz00VkR8vEe+udxLOtP6sTjlBj0aY38cKjVeeg06v18ldqz4ehKCXoqLWG0emXRs5/2KCE tKb2QURK3ygLRQoNHs08YlNrHxl1rgIE8Iksc6eJyaUSz++xS7Mp0wejEW1wrddbFK+dmsIPraB0P ba5wl6wOyPSz3bdRO6CAJxeGZX6trtDLxKSQ3LOy/mvLb+TTq9LqadG+Y2cvjRq+XEJt21QErwk1i aEKIDHHv7IpNzCtwZzl8iY6FYhs3bkSdTV+ZIN1IhW+av48U/TzCLsDs+B3yAOn0LJ03r4m2xkNYx a+sNasaw==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rGYsd-0053gU-31; Fri, 22 Dec 2023 06:19:31 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , "Rafael J . Wysocki" , Daniel Lezcano , Zhang Rui , Lukasz Luba , linux-pm@vger.kernel.org Subject: [PATCH] thermal: max7620: fix all kernel-doc warnings Date: Thu, 21 Dec 2023 22:19:31 -0800 Message-ID: <20231222061931.10807-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785961917238691563 X-GMAIL-MSGID: 1785961917238691563 Correct all kernel-doc notation to prevent warnings from scripts/kernel-doc: max77620_thermal.c:48: warning: Function parameter or member 'tz' not described in 'max77620_thermal_read_temp' max77620_thermal.c:48: warning: Excess function parameter 'data' description in 'max77620_thermal_read_temp' max77620_thermal.c:48: warning: No description found for return value of 'max77620_thermal_read_temp' Signed-off-by: Randy Dunlap Cc: Rafael J. Wysocki Cc: Daniel Lezcano Cc: Zhang Rui Cc: Lukasz Luba Cc: linux-pm@vger.kernel.org --- drivers/thermal/max77620_thermal.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff -- a/drivers/thermal/max77620_thermal.c b/drivers/thermal/max77620_thermal.c --- a/drivers/thermal/max77620_thermal.c +++ b/drivers/thermal/max77620_thermal.c @@ -32,7 +32,7 @@ struct max77620_therm_info { /** * max77620_thermal_read_temp: Read PMIC die temperatue. - * @data: Device specific data. + * @tz: pointer to &thermal_zone_device * @temp: Temperature in millidegrees Celsius * * The actual temperature of PMIC die is not available from PMIC. @@ -41,7 +41,7 @@ struct max77620_therm_info { * If threshold has not been crossed then assume die temperature as 100degC * else 120degC or 140deG based on the PMIC die temp threshold status. * - * Return 0 on success otherwise error number to show reason of failure. + * Return: %0 on success otherwise error number to show reason of failure. */ static int max77620_thermal_read_temp(struct thermal_zone_device *tz, int *temp)