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>

1 files changed, 5 insertions, 5 deletions

diff --git a/include/time.h b/include/time.h
index 3f00e68713..9deb2cf61c 100644
--- a/include/time.h
+++ b/include/time.h
@@ -24,7 +24,7 @@ uint64_t get_timer_us(uint64_t base);
  * delays of over an hour. For 64-bit machines it uses a 64-bit value.
  *
  *@base: Base time to consider
- *@return elapsed time since @base
+ *Return: elapsed time since @base
  */
 unsigned long get_timer_us_long(unsigned long base);
 
@@ -87,7 +87,7 @@ uint64_t usec_to_tick(unsigned long usec);
  * usec2ticks() - Convert microseconds to internal ticks
  *
  * @usec: Value of microseconds to convert
- * @return Corresponding internal ticks value, calculated using get_tbclk()
+ * Return: Corresponding internal ticks value, calculated using get_tbclk()
  */
 ulong usec2ticks(unsigned long usec);
 
@@ -95,7 +95,7 @@ ulong usec2ticks(unsigned long usec);
  * ticks2usec() - Convert internal ticks to microseconds
  *
  * @ticks: Value of ticks to convert
- * @return Corresponding microseconds value, calculated using get_tbclk()
+ * Return: Corresponding microseconds value, calculated using get_tbclk()
  */
 ulong ticks2usec(unsigned long ticks);
 
@@ -112,7 +112,7 @@ void wait_ticks(unsigned long ticks);
 /**
  * timer_get_us() - Get monotonic microsecond timer
  *
- * @return value of monotonic microsecond timer
+ * Return: value of monotonic microsecond timer
  */
 unsigned long timer_get_us(void);
 
@@ -122,7 +122,7 @@ unsigned long timer_get_us(void);
  * This is an internal value used by the timer on the system. Ticks increase
  * monotonically at the rate given by get_tbclk().
  *
- * @return current tick value
+ * Return: current tick value
  */
 uint64_t get_ticks(void);