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>

10 files changed, 41 insertions, 41 deletions

diff --git a/drivers/sound/hda_codec.c b/drivers/sound/hda_codec.c
index eb92830ad9..af6148ef72 100644
--- a/drivers/sound/hda_codec.c
+++ b/drivers/sound/hda_codec.c
@@ -302,7 +302,7 @@ int hda_codecs_init(struct udevice *dev, struct hda_regs *regs, u32 codec_mask)
  * @regs: HDA registers
  * @val: Command to write
  * @response: Set to response from codec
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int exec_verb(struct hda_regs *regs, uint val, uint *response)
 {
@@ -324,7 +324,7 @@ static int exec_verb(struct hda_regs *regs, uint val, uint *response)
  * @nid: Parent node ID to check
  * @num_sub_nodesp: Returns number of subnodes
  * @start_sub_node_nidp: Returns start subnode number
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int get_subnode_info(struct hda_regs *regs, uint nid,
 			    uint *num_sub_nodesp, uint *start_sub_node_nidp)
@@ -354,7 +354,7 @@ static int get_subnode_info(struct hda_regs *regs, uint nid,
  *
  * @regs: HDA registers
  * @group_nid: Group node ID to check
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static uint find_beep_node_in_group(struct hda_regs *regs, uint group_nid)
 {
@@ -395,7 +395,7 @@ static uint find_beep_node_in_group(struct hda_regs *regs, uint group_nid)
  * Checks if the given audio group contains a beep generator
  * @regs: HDA registers
  * @nid: Node ID to check
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int audio_group_has_beep_node(struct hda_regs *regs, uint nid)
 {
@@ -424,7 +424,7 @@ static int audio_group_has_beep_node(struct hda_regs *regs, uint nid)
  * instead.
  *
  * @dev: Sound device
- * @return Node ID >0 if found, -ve error code otherwise
+ * Return: Node ID >0 if found, -ve error code otherwise
  */
 static int get_hda_beep_nid(struct udevice *dev)
 {
@@ -461,7 +461,7 @@ static int get_hda_beep_nid(struct udevice *dev)
  *
  * @priv: Device's private data
  * @divider: Divider value (0 to disable the beep)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int set_beep_divisor(struct hda_codec_priv *priv, uint divider)
 {
diff --git a/drivers/sound/max98088.c b/drivers/sound/max98088.c
index 4bcb7482b2..c0463b8e8a 100644
--- a/drivers/sound/max98088.c
+++ b/drivers/sound/max98088.c
@@ -30,7 +30,7 @@ static const int rate_table[] = {0, 8000, 11025, 16000, 22050, 24000, 32000,
  * @param rate sampling rate
  * @param value address of indexvalue to be stored
  *
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int rate_value(int rate, u8 *value)
 {
@@ -54,7 +54,7 @@ static int rate_value(int rate, u8 *value)
  * @rate: Sampling rate
  * @bits_per_sample: Bits per sample
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98088_hw_params(struct maxim_priv *priv, unsigned int rate,
 		       unsigned int bits_per_sample)
@@ -115,7 +115,7 @@ int max98088_hw_params(struct maxim_priv *priv, unsigned int rate,
  * @priv: max98088 information
  * @freq: Sampling frequency in Hz
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98088_set_sysclk(struct maxim_priv *priv, unsigned int freq)
 {
@@ -163,7 +163,7 @@ int max98088_set_sysclk(struct maxim_priv *priv, unsigned int freq)
  * @priv: max98088 information
  * @fmt: i2S format - supports a subset of the options defined in i2s.h.
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98088_set_fmt(struct maxim_priv *priv, int fmt)
 {
@@ -241,7 +241,7 @@ int max98088_set_fmt(struct maxim_priv *priv, int fmt)
  * max98088_reset() - reset the audio codec
  *
  * @priv: max98088 information
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 static int max98088_reset(struct maxim_priv *priv)
 {
@@ -278,7 +278,7 @@ static int max98088_reset(struct maxim_priv *priv)
  *
  * @priv: max98088 information
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 static int max98088_device_init(struct maxim_priv *priv)
 {
diff --git a/drivers/sound/max98090.c b/drivers/sound/max98090.c
index c77a732277..a798762f1e 100644
--- a/drivers/sound/max98090.c
+++ b/drivers/sound/max98090.c
@@ -25,7 +25,7 @@
  * @rate: Sampling rate
  * @bits_per_sample: Bits per sample
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98090_hw_params(struct maxim_priv *priv, unsigned int rate,
 		       unsigned int bits_per_sample)
@@ -77,7 +77,7 @@ int max98090_hw_params(struct maxim_priv *priv, unsigned int rate,
  * @priv: max98090 information
  * @freq: Sampling frequency in Hz
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98090_set_sysclk(struct maxim_priv *priv, unsigned int freq)
 {
@@ -122,7 +122,7 @@ int max98090_set_sysclk(struct maxim_priv *priv, unsigned int freq)
  * @priv: max98090 information
  * @fmt: i2S format - supports a subset of the options defined in i2s.h.
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98090_set_fmt(struct maxim_priv *priv, int fmt)
 {
@@ -205,7 +205,7 @@ int max98090_set_fmt(struct maxim_priv *priv, int fmt)
  * resets the audio codec
  *
  * @priv: max98090 information
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 static int max98090_reset(struct maxim_priv *priv)
 {
@@ -231,7 +231,7 @@ static int max98090_reset(struct maxim_priv *priv)
  *
  * @priv: max98090 information
  *
- * @return -EIO for error, 0 for success.
+ * Return: -EIO for error, 0 for success.
  */
 int max98090_device_init(struct maxim_priv *priv)
 {
diff --git a/drivers/sound/max98095.c b/drivers/sound/max98095.c
index 002dab437f..d0f701aaf1 100644
--- a/drivers/sound/max98095.c
+++ b/drivers/sound/max98095.c
@@ -29,7 +29,7 @@ int rate_table[] = {0, 8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000,
  * @param rate sampling rate
  * @param value address of indexvalue to be stored
  *
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int rate_value(int rate, u8 *value)
 {
@@ -53,7 +53,7 @@ static int rate_value(int rate, u8 *value)
  * @param rate		Sampling rate
  * @param bits_per_sample	Bits per sample
  *
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int max98095_hw_params(struct maxim_priv *priv,
 			      enum en_max_audio_interface aif_id,
@@ -121,7 +121,7 @@ static int max98095_hw_params(struct maxim_priv *priv,
  * @param priv		max98095 information
  * @param freq		Sampling frequency in Hz
  *
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int max98095_set_sysclk(struct maxim_priv *priv, unsigned int freq)
 {
@@ -163,7 +163,7 @@ static int max98095_set_sysclk(struct maxim_priv *priv, unsigned int freq)
  * @param fmt		i2S format - supports a subset of the options defined
  *			in i2s.h.
  *
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int max98095_set_fmt(struct maxim_priv *priv, int fmt,
 			    enum en_max_audio_interface aif_id)
@@ -255,7 +255,7 @@ static int max98095_set_fmt(struct maxim_priv *priv, int fmt,
  * resets the audio codec
  *
  * @param priv	Private data for driver
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int max98095_reset(struct maxim_priv *priv)
 {
@@ -296,7 +296,7 @@ static int max98095_reset(struct maxim_priv *priv)
  * Intialise max98095 codec device
  *
  * @param priv		max98095 information
- * @return	0 for success or negative error code.
+ * Return:	0 for success or negative error code.
  */
 static int max98095_device_init(struct maxim_priv *priv)
 {
diff --git a/drivers/sound/maxim_codec.c b/drivers/sound/maxim_codec.c
index 31e67ee672..6553d95904 100644
--- a/drivers/sound/maxim_codec.c
+++ b/drivers/sound/maxim_codec.c
@@ -22,7 +22,7 @@
  * @param reg	reg number to be write
  * @param data	data to be writen to the above registor
  *
- * @return	int value 1 for change, 0 for no change or negative error code.
+ * Return:	int value 1 for change, 0 for no change or negative error code.
  */
 int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg,
 		    unsigned char data)
@@ -39,7 +39,7 @@ int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg,
  * @param reg	reg number to be read
  * @param data	address of read data to be stored
  *
- * @return	int value 0 for success, -1 in case of error.
+ * Return:	int value 0 for success, -1 in case of error.
  */
 unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg,
 			    unsigned char *data)
@@ -64,7 +64,7 @@ unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg,
  * @param mask	register mask
  * @param value	new value
  *
- * @return int value 0 for success, non-zero error code.
+ * Return: int value 0 for success, non-zero error code.
  */
 int maxim_bic_or(struct maxim_priv *priv, unsigned int reg, unsigned char mask,
 		 unsigned char value)
diff --git a/drivers/sound/maxim_codec.h b/drivers/sound/maxim_codec.h
index a3128e0bb7..deaefd93eb 100644
--- a/drivers/sound/maxim_codec.h
+++ b/drivers/sound/maxim_codec.h
@@ -34,7 +34,7 @@ struct maxim_priv {
  * @param reg	reg number to be write
  * @param data	data to be writen to the above registor
  *
- * @return	int value 1 for change, 0 for no change or negative error code.
+ * Return:	int value 1 for change, 0 for no change or negative error code.
  */
 int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg,
 		    unsigned char data);
@@ -46,7 +46,7 @@ int maxim_i2c_write(struct maxim_priv *priv, unsigned int reg,
  * @param reg	reg number to be read
  * @param data	address of read data to be stored
  *
- * @return	int value 0 for success, -1 in case of error.
+ * Return:	int value 0 for success, -1 in case of error.
  */
 unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg,
 			    unsigned char *data);
@@ -59,7 +59,7 @@ unsigned int maxim_i2c_read(struct maxim_priv *priv, unsigned int reg,
  * @param mask	register mask
  * @param value	new value
  *
- * @return int value 0 for success, non-zero error code.
+ * Return: int value 0 for success, non-zero error code.
  */
 int maxim_bic_or(struct maxim_priv *priv, unsigned int reg, unsigned char mask,
 		 unsigned char value);
diff --git a/drivers/sound/samsung-i2s.c b/drivers/sound/samsung-i2s.c
index d3d75c046e..dc5a2789ae 100644
--- a/drivers/sound/samsung-i2s.c
+++ b/drivers/sound/samsung-i2s.c
@@ -126,7 +126,7 @@ static void i2s_fifo(struct i2s_reg *i2s_reg, unsigned int flush)
  * @param i2s_reg	i2s register address
  * @param dir		Clock direction
  *
- * @return		int value 0 for success, -1 in case of error
+ * Return:		int value 0 for success, -1 in case of error
  */
 static int i2s_set_sysclk_dir(struct i2s_reg *i2s_reg, int dir)
 {
@@ -148,7 +148,7 @@ static int i2s_set_sysclk_dir(struct i2s_reg *i2s_reg, int dir)
  * @param fmt		i2s clock properties
  * @param i2s_reg	i2s register address
  *
- * @return		int value 0 for success, -1 in case of error
+ * Return:		int value 0 for success, -1 in case of error
  */
 static int i2s_set_fmt(struct i2s_reg *i2s_reg, unsigned int fmt)
 {
@@ -225,7 +225,7 @@ static int i2s_set_fmt(struct i2s_reg *i2s_reg, unsigned int fmt)
  * @param blc		samplewidth (size of sample in bits)
  * @param i2s_reg	i2s register address
  *
- * @return		int value 0 for success, -1 in case of error
+ * Return:		int value 0 for success, -1 in case of error
  */
 static int i2s_set_samplesize(struct i2s_reg *i2s_reg, unsigned int blc)
 {
diff --git a/drivers/sound/tegra_ahub.c b/drivers/sound/tegra_ahub.c
index 8708fc44a9..495a29c513 100644
--- a/drivers/sound/tegra_ahub.c
+++ b/drivers/sound/tegra_ahub.c
@@ -70,7 +70,7 @@ static int tegra_ahub_apbif_is_full(struct udevice *dev)
 /**
  * tegra_ahub_wait_for_space() - Wait for space in the FIFO
  *
- * @return 0 if OK, -ETIMEDOUT if no space was available in time
+ * Return: 0 if OK, -ETIMEDOUT if no space was available in time
  */
 static int tegra_ahub_wait_for_space(struct udevice *dev)
 {
diff --git a/drivers/sound/tegra_i2s_priv.h b/drivers/sound/tegra_i2s_priv.h
index 7cd3fc808c..65a3623ad9 100644
--- a/drivers/sound/tegra_i2s_priv.h
+++ b/drivers/sound/tegra_i2s_priv.h
@@ -22,7 +22,7 @@ enum {
  *
  * @dev: I2S device
  * @value: Value to write to CIF_TX_CTRL register
- * @return 0
+ * Return: 0
  */
 int tegra_i2s_set_cif_tx_ctrl(struct udevice *dev, u32 value);
 
diff --git a/drivers/sound/wm8994.c b/drivers/sound/wm8994.c
index cb1e97d7a5..fd646479b3 100644
--- a/drivers/sound/wm8994.c
+++ b/drivers/sound/wm8994.c
@@ -71,7 +71,7 @@ static int bclk_divs[] = {
  * @param reg	reg number to be write
  * @param data	data to be writen to the above registor
  *
- * @return	int value 1 for change, 0 for no change or negative error code.
+ * Return:	int value 1 for change, 0 for no change or negative error code.
  */
 static int wm8994_i2c_write(struct wm8994_priv *priv, unsigned int reg,
 			    unsigned short data)
@@ -92,7 +92,7 @@ static int wm8994_i2c_write(struct wm8994_priv *priv, unsigned int reg,
  * @param reg	reg number to be read
  * @param data	address of read data to be stored
  *
- * @return	int value 0 for success, -1 in case of error.
+ * Return:	int value 0 for success, -1 in case of error.
  */
 static unsigned int wm8994_i2c_read(struct wm8994_priv *priv, unsigned int reg,
 				    unsigned short *data)
@@ -122,7 +122,7 @@ static unsigned int wm8994_i2c_read(struct wm8994_priv *priv, unsigned int reg,
  * @param mask	register mask
  * @param value	new value
  *
- * @return int value 1 if change in the register value,
+ * Return: int value 1 if change in the register value,
  * 0 for no change or negative error code.
  */
 static int wm8994_bic_or(struct wm8994_priv *priv, unsigned int reg,
@@ -150,7 +150,7 @@ static int wm8994_bic_or(struct wm8994_priv *priv, unsigned int reg,
  * @param aif_id	Interface ID
  * @param fmt		i2S format
  *
- * @return -1 for error and 0  Success.
+ * Return: -1 for error and 0  Success.
  */
 static int wm8994_set_fmt(struct wm8994_priv *priv, int aif_id, uint fmt)
 {
@@ -274,7 +274,7 @@ static int wm8994_set_fmt(struct wm8994_priv *priv, int aif_id, uint fmt)
  * @param bits_per_sample	Bits per sample
  * @param Channels		Channels in the given audio input
  *
- * @return -1 for error  and 0  Success.
+ * Return: -1 for error  and 0  Success.
  */
 static int wm8994_hw_params(struct wm8994_priv *priv, int aif_id,
 			    uint sampling_rate, uint bits_per_sample,
@@ -417,7 +417,7 @@ static int wm8994_hw_params(struct wm8994_priv *priv, int aif_id,
  * @param priv		wm8994 information pointer
  * @param aif		Audio Interface ID
  *
- * @return -1 for error  and 0  Success.
+ * Return: -1 for error  and 0  Success.
  */
 static int configure_aif_clock(struct wm8994_priv *priv, int aif)
 {
@@ -497,7 +497,7 @@ static int configure_aif_clock(struct wm8994_priv *priv, int aif)
  * @param clk_id	Input Clock ID
  * @param freq		Sampling frequency in Hz
  *
- * @return -1 for error and 0 success.
+ * Return: -1 for error and 0 success.
  */
 static int wm8994_set_sysclk(struct wm8994_priv *priv, int aif_id, int clk_id,
 			     unsigned int freq)