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/mips/mach-octeon/include/mach/cvmx-regs.h b/arch/mips/mach-octeon/include/mach/cvmx-regs.h
index 9e86be8..dbb7723 100644
--- a/arch/mips/mach-octeon/include/mach/cvmx-regs.h
+++ b/arch/mips/mach-octeon/include/mach/cvmx-regs.h
@@ -295,7 +295,7 @@
*
* @param major_did 5 bit major did
* @param sub_did 3 bit sub did
- * @return I/O base address
+ * Return: I/O base address
*/
static inline u64 cvmx_build_io_address(u64 major_did, u64 sub_did)
{
@@ -306,7 +306,7 @@
* Builds a bit mask given the required size in bits.
*
* @param bits Number of bits in the mask
- * @return The mask
+ * Return: The mask
*/
static inline u64 cvmx_build_mask(u64 bits)
{
@@ -323,7 +323,7 @@
* @param lsb Starting bit, least significant (0-63)
* @param width Width in bits (1-64)
*
- * @return Extracted number
+ * Return: Extracted number
*/
static inline u64 cvmx_bit_extract(u64 input, int lsb, int width)
{
@@ -349,7 +349,7 @@
* @param high_bit Highest bit value can occupy (inclusive) 0-63
* @param low_bit Lowest bit value can occupy inclusive 0-high_bit
* @param value Value to use
- * @return Value masked and shifted
+ * Return: Value masked and shifted
*/
static inline u64 cvmx_build_bits(u64 high_bit, u64 low_bit, u64 value)
{
@@ -379,7 +379,7 @@
/**
* Number of the Core on which the program is currently running.
*
- * @return core number
+ * Return: core number
*/
static inline unsigned int cvmx_get_core_num(void)
{
@@ -392,7 +392,7 @@
/**
* Node-local number of the core on which the program is currently running.
*
- * @return core number on local node
+ * Return: core number on local node
*/
static inline unsigned int cvmx_get_local_core_num(void)
{
@@ -411,7 +411,7 @@
*
* @param val 32 bit value to count set bits in
*
- * @return Number of bits set
+ * Return: Number of bits set
*/
static inline u32 cvmx_pop(u32 val)
{