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/drivers/sound/max98088.c b/drivers/sound/max98088.c
index 4bcb748..c0463b8 100644
--- a/drivers/sound/max98088.c
+++ b/drivers/sound/max98088.c
@@ -30,7 +30,7 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* 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 @@
*
* @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)
{