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/arch/x86/include/asm/arch-apollolake/fsp_bindings.h b/arch/x86/include/asm/arch-apollolake/fsp_bindings.h
index a80e66b..ae1f1b7 100644
--- a/arch/x86/include/asm/arch-apollolake/fsp_bindings.h
+++ b/arch/x86/include/asm/arch-apollolake/fsp_bindings.h
@@ -86,7 +86,7 @@
* fsp_m_update_config_from_dtb() - Read FSP-M config from devicetree node
* @node: Valid node reference to read property from
* @cfg: Pointer to FSP-M config structure
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* This function reads the configuration for FSP-M from the provided
* devicetree node and saves it in the FSP-M configuration structure.
@@ -99,7 +99,7 @@
* fsp_s_update_config_from_dtb() - Read FSP-S config from devicetree node
* @node: Valid node reference to read property from
* @cfg: Pointer to FSP-S config structure
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*
* This function reads the configuration for FSP-S from the provided
* devicetree node and saves it in the FSP-S configuration structure.
diff --git a/arch/x86/include/asm/arch-apollolake/lpc.h b/arch/x86/include/asm/arch-apollolake/lpc.h
index 977b7ec..51d478f 100644
--- a/arch/x86/include/asm/arch-apollolake/lpc.h
+++ b/arch/x86/include/asm/arch-apollolake/lpc.h
@@ -67,7 +67,7 @@
*
* @base: Base I/O address (e.g. 0x800)
* @size: Size of window (e.g. 0x100)
- * @return 0 if OK, -ENOSPC if there are no more windows available, -EALREADY
+ * Return: 0 if OK, -ENOSPC if there are no more windows available, -EALREADY
* if already set up
*/
int lpc_open_pmio_window(uint base, uint size);
diff --git a/arch/x86/include/asm/arch-apollolake/systemagent.h b/arch/x86/include/asm/arch-apollolake/systemagent.h
index 48e76c2..25dbc9c 100644
--- a/arch/x86/include/asm/arch-apollolake/systemagent.h
+++ b/arch/x86/include/asm/arch-apollolake/systemagent.h
@@ -45,7 +45,7 @@
* below 4GB
*
* @dev: hostbridge device
- * @return TOLUD address
+ * Return: TOLUD address
*/
ulong sa_get_tolud_base(struct udevice *dev);
@@ -56,7 +56,7 @@
* for Graphics Translation Tables.
*
* @dev: hostbridge device
- * @return GSM address
+ * Return: GSM address
*/
ulong sa_get_gsm_base(struct udevice *dev);
@@ -65,7 +65,7 @@
*
* This returns the top address of DRAM available below 4GB
*
- * @return TSEG base
+ * Return: TSEG base
*/
ulong sa_get_tseg_base(struct udevice *dev);