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>
This commit is contained in:
@@ -84,7 +84,7 @@ u8 clk_mux_get_parent(struct clk *clk);
|
||||
* @table: array of register values corresponding to the parent index (optional)
|
||||
* @flags: hardware-specific flags
|
||||
* @index: parent clock index
|
||||
* @return the register value
|
||||
* Return: the register value
|
||||
*/
|
||||
unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index);
|
||||
|
||||
@@ -143,7 +143,7 @@ extern const struct clk_ops clk_divider_ops;
|
||||
*
|
||||
* @table: array of register values corresponding to valid dividers
|
||||
* @val: value to convert
|
||||
* @return the divider
|
||||
* Return: the divider
|
||||
*/
|
||||
unsigned int clk_divider_get_table_div(const struct clk_div_table *table,
|
||||
unsigned int val);
|
||||
@@ -156,7 +156,7 @@ unsigned int clk_divider_get_table_div(const struct clk_div_table *table,
|
||||
*
|
||||
* @table: array of register values corresponding to valid dividers
|
||||
* @div: requested divider
|
||||
* @return the register value
|
||||
* Return: the register value
|
||||
*/
|
||||
unsigned int clk_divider_get_table_val(const struct clk_div_table *table,
|
||||
unsigned int div);
|
||||
@@ -167,7 +167,7 @@ unsigned int clk_divider_get_table_val(const struct clk_div_table *table,
|
||||
* @table: array of valid dividers (optional)
|
||||
* @div: divider to check
|
||||
* @flags: hardware-specific flags
|
||||
* @return true if the divider is valid, false otherwise
|
||||
* Return: true if the divider is valid, false otherwise
|
||||
*/
|
||||
bool clk_divider_is_valid_div(const struct clk_div_table *table,
|
||||
unsigned int div, unsigned long flags);
|
||||
@@ -177,7 +177,7 @@ bool clk_divider_is_valid_div(const struct clk_div_table *table,
|
||||
*
|
||||
* @table: array of valid dividers
|
||||
* @div: divider to check
|
||||
* @return true if the divider is found in the @table array, false otherwise
|
||||
* Return: true if the divider is found in the @table array, false otherwise
|
||||
*/
|
||||
bool clk_divider_is_valid_table_div(const struct clk_div_table *table,
|
||||
unsigned int div);
|
||||
|
||||
@@ -62,7 +62,7 @@ extern char * strchr(const char *,int);
|
||||
* NULL
|
||||
* @s: string to search
|
||||
* @c: character to search for
|
||||
* @return position of @c in @s, or end of @s if not found
|
||||
* Return: position of @c in @s, or end of @s if not found
|
||||
*/
|
||||
const char *strchrnul(const char *s, int c);
|
||||
|
||||
@@ -89,7 +89,7 @@ extern __kernel_size_t strnlen(const char *,__kernel_size_t);
|
||||
*
|
||||
* @s: string to search
|
||||
* @reject: strings which cause the search to halt
|
||||
* @return number of characters at the start of @s which are not in @reject
|
||||
* Return: number of characters at the start of @s which are not in @reject
|
||||
*/
|
||||
size_t strcspn(const char *s, const char *reject);
|
||||
#endif
|
||||
@@ -136,7 +136,7 @@ void *memchr_inv(const void *, int, size_t);
|
||||
*
|
||||
* @src: data to copy in
|
||||
* @len: number of bytes to copy
|
||||
* @return allocated buffer with the copied contents, or NULL if not enough
|
||||
* Return: allocated buffer with the copied contents, or NULL if not enough
|
||||
* memory is available
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -1151,7 +1151,7 @@ struct abuf;
|
||||
*
|
||||
* @in: Input buffer to decompress
|
||||
* @out: Output buffer to hold the results (must be large enough)
|
||||
* @return size of the decompressed data, or -ve on error
|
||||
* Return: size of the decompressed data, or -ve on error
|
||||
*/
|
||||
int zstd_decompress(struct abuf *in, struct abuf *out);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user