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

Heinrich Schuchardt heinrich.schuchardt at canonical.com
Thu Mar 24 16:22:32 CET 2022


We use Sphinx style comments to describe functions.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at 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);
 
-- 
2.34.1



More information about the U-Boot mailing list