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/mtrr.h b/arch/x86/include/asm/mtrr.h
index d1aa86b..ca2edc7 100644
--- a/arch/x86/include/asm/mtrr.h
+++ b/arch/x86/include/asm/mtrr.h
@@ -145,7 +145,7 @@
* @type: Requested type (MTRR_TYPE_)
* @start: Start address
* @size: Size, must be power of 2
- * @return 0 on success, -EINVAL if size is not power of 2,
+ * Return: 0 on success, -EINVAL if size is not power of 2,
* -ENOSPC if there are no more MTRRs
*/
int mtrr_set_next_var(uint type, uint64_t base, uint64_t size);
@@ -166,7 +166,7 @@
* @cpu_select: Selected CPUs (either a CPU number or MP_SELECT_...)
* @reg: MTRR register to write (0-7)
* @valid: Valid flag to write
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int mtrr_set_valid(int cpu_select, int reg, bool valid);
@@ -177,7 +177,7 @@
* @reg: MTRR register to write (0-7)
* @base: Base address and MTRR_BASE_TYPE_MASK
* @mask: Mask and MTRR_PHYS_MASK_VALID
- * @return 0 on success, -ve on error
+ * Return: 0 on success, -ve on error
*/
int mtrr_set(int cpu_select, int reg, u64 base, u64 mask);
@@ -186,7 +186,7 @@
*
* Some CPUs have more than 8 MTRRs. This function returns the actual number
*
- * @return number of variable MTRRs
+ * Return: number of variable MTRRs
*/
int mtrr_get_var_count(void);