]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
dm: fix function documentation in include/dm/ofnode.h
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Thu, 24 Mar 2022 15:22:32 +0000 (16:22 +0100)
committerTom Rini <trini@konsulko.com>
Wed, 6 Apr 2022 13:21:49 +0000 (09:21 -0400)
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>
include/dm/ofnode.h

index 744dffe0a2dd285362f22dfe153b3469109bd913..6a996d952171e1c282c5c78c07352bef79b22acd 100644 (file)
@@ -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);