From:   =?UTF-8?q?Jonathan=20Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>
To:     netdev@vger.kernel.org
Cc:     =?UTF-8?q?Jonathan=20Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>,
        "David S. Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>, linux-kernel@vger.kernel.org
Subject: [PATCH] net: Add kerneldoc comment to napi_complete_done
Date:   Sun, 29 Jan 2023 14:26:18 +0100
Message-Id: <20230129132618.1361421-1-j.neuschaefer@gmx.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
UI-OutboundReport: notjunk:1;M01:P0:iJySu1Rp10g=;8+B9zMuSrQRw8DXU7ruOAwdHFub
 bEbsnG6DRaK29GidFPnBl6nukhaCgkq1kiqHp1Me6nwNCxNKmwgGwWHlGKWvg15EmdGA4I54m
 AEaRXwy1mbkdjt9g2HIicuJL8/SpKOnfVbTZM8IZtdv93U4/kwJDYfVm2zLf6I4tiPRT+52up
 e1+FTh4o6RM9apNAy13+k5dOFV/gxEh2aG73NiWyE8lRhAyWpkXviRPPZaCC7kbUqFsJEeBTd
 uySh16CXLsnxfkIP2rvViFx+DfEYxUu/OzGUke+aZ8f5uN5AiNORUwoYRt/rCPrCVeiEA00Vu
 kUzrRqi0A+dqYqPolMJXsNe3f6IsOebpf0Y0lLHbPSnGt9biiBwlbPDzNuWlKLJdLxLv5IX0l
 SmqrBPE6MIxnm2BpznAcn0MfZ8CnnJxIreSo8EBueMhF//Lu+7fnI7/4yJneSjHx4+jmMVHYl
 RDKVu1VAcyKsEcyLktcX4sYjpOHIcEtsR/+5OCXLuXzohWoj9IP33tr3b3K3eqACy+FPXaUeW
 vY+/5kT801RhengEYaLutu9PDPwn9ckDPN5eIjd2kQF/ZsSDnoSq8Z1tMXJu2iRYZFnDmwW9o
 IeboZ9uxUCJ0rujyboFLSo+2vXadnlnjgQL4tSd/a1qxsQ4VOloXiY39cbcGdIAelq8blgZsR
 1Hx3gs3wqBO4n/eWQ7E7PtngUEljOWVcGEGW7VcUhmR+cRzQ0rJC1DikWemiFssV0m8OKKLUn
 G67fFg3Gl3mL2L2O6uz8UuTtqDQO8zJIeVeGun3X3F6RgFAwcoV82Qzmqnv4IDnzlLu6wzgzd
 YGMqA+xoEnOKTGpXf7N2iJU8Me6q+aQwCImT8G278jGgUhKAMYsTP3rcmF6S6nSrp8SckbcfF
 m/ai4CmFqgFX+EalRIDE5O2QLGhCBNPOaUXDMdVEYUJ252nwpeBWW4s5RegB15DCtOzq8MIhA
 71J74X7FJjDJ21eaCFGOugsp+jA=
Precedence: bulk

Document napi_complete_done, so that it shows up in HTML documentation.

Signed-off-by: Jonathan Neusch=C3=A4fer <j.neuschaefer@gmx.net>
=2D--
 include/linux/netdevice.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index aad12a179e540..828e58791baa1 100644
=2D-- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -504,7 +504,16 @@ static inline bool napi_reschedule(struct napi_struct=
 *napi)
 	return false;
 }

+/**
+ *	napi_complete_done - NAPI processing complete
+ *	@n: NAPI context
+ *	@work_done: The number of packets that were processed
+ *
+ * Mark NAPI processing as complete.
+ * Return false if device should avoid rearming interrupts.
+ */
 bool napi_complete_done(struct napi_struct *n, int work_done);
+
 /**
  *	napi_complete - NAPI processing complete
  *	@n: NAPI context
=2D-
2.39.0