doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
diff --git a/include/ahci.h b/include/ahci.h
index d545304..d7f951c 100644
--- a/include/ahci.h
+++ b/include/ahci.h
@@ -202,7 +202,7 @@
* sata_reset() - reset the controller
*
* @dev: Controller to reset
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sata_reset(struct udevice *dev);
@@ -211,7 +211,7 @@
*
* @dev: Controller to reset
* @port: Port number to check (0 for first)
- * @return 0 if detected, -ENXIO if nothin on port, other -ve on error
+ * Return: 0 if detected, -ENXIO if nothin on port, other -ve on error
*/
int sata_dm_port_status(struct udevice *dev, int port);
@@ -219,7 +219,7 @@
* sata_scan() - scan SATA ports
*
* @dev: Controller to scan
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int sata_scan(struct udevice *dev);
@@ -254,7 +254,7 @@
*
* @ahci_dev: AHCI parent device
* @devp: Returns new SCSI bus device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_bind_scsi(struct udevice *ahci_dev, struct udevice **devp);
@@ -266,7 +266,7 @@
*
* @ahci_dev: AHCI parent device
* @base: Base address of AHCI port
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_probe_scsi(struct udevice *ahci_dev, ulong base);
@@ -277,7 +277,7 @@
* devices it finds.
*
* @ahci_dev: AHCI parent device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int ahci_probe_scsi_pci(struct udevice *ahci_dev);