[PATCH 1/1] dm: fix function documentation in include/dm/ofnode.h

We use Sphinx style comments to describe functions.
Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com --- include/dm/ofnode.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h index 744dffe0a2..6a996d9521 100644 --- a/include/dm/ofnode.h +++ b/include/dm/ofnode.h @@ -900,10 +900,10 @@ int ofnode_read_pci_vendev(ofnode node, u16 *vendor, u16 *device); * Look at the compatible property of a device node that represents a eth phy * device and extract phy vendor id and device id from it. * - * @param node node to examine - * @param vendor vendor id of the eth phy device - * @param device device id of the eth phy device - * @return 0 if ok, negative on error + * @node: node to examine + * @vendor: vendor id of the eth phy device + * @device: device id of the eth phy device + * Return: 0 if ok, negative on error */ int ofnode_read_eth_phy_id(ofnode node, u16 *vendor, u16 *device);

On Thu, Mar 24, 2022 at 11:22 PM Heinrich Schuchardt heinrich.schuchardt@canonical.com wrote:
We use Sphinx style comments to describe functions.
Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com
include/dm/ofnode.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Reviewed-by: Bin Meng bmeng.cn@gmail.com

On Thu, Mar 24, 2022 at 04:22:32PM +0100, Heinrich Schuchardt wrote:
We use Sphinx style comments to describe functions.
Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com Reviewed-by: Bin Meng bmeng.cn@gmail.com
Applied to u-boot/master, thanks!
participants (3)
-
Bin Meng
-
Heinrich Schuchardt
-
Tom Rini