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/hda_codec.c b/drivers/sound/hda_codec.c
index eb92830..af6148e 100644
--- a/drivers/sound/hda_codec.c
+++ b/drivers/sound/hda_codec.c
@@ -302,7 +302,7 @@
* @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 @@
* @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 @@
*
* @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 @@
* 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 @@
* 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 @@
*
* @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)
{