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/tools/rkcommon.h b/tools/rkcommon.h
index 9351882..49b6df3 100644
--- a/tools/rkcommon.h
+++ b/tools/rkcommon.h
@@ -19,7 +19,7 @@
/**
* rkcommon_check_params() - check params
*
- * @return 0 if OK, -1 if ERROR.
+ * Return: 0 if OK, -1 if ERROR.
*/
int rkcommon_check_params(struct image_tool_params *params);
@@ -56,7 +56,7 @@
*
* @buf: Pointer to the image file
* @file_size: Size of entire bootable image file (incl. all padding)
- * @return 0 if OK
+ * Return: 0 if OK
*/
int rkcommon_verify_header(unsigned char *buf, int size,
struct image_tool_params *params);
@@ -76,7 +76,7 @@
* Some socs cannot disable the rc4-encryption of the spl binary.
* rc4 encryption is disabled normally except on socs that cannot
* handle unencrypted binaries.
- * @return true or false depending on rc4 being required.
+ * Return: true or false depending on rc4 being required.
*/
bool rkcommon_need_rc4_spl(struct image_tool_params *params);
@@ -99,7 +99,7 @@
* @tparams: Pointer tot the image type structure (for setting
* the header and header_size)
*
- * @return 0 (always)
+ * Return: 0 (always)
*/
int rkcommon_vrec_header(struct image_tool_params *params,
struct image_type_params *tparams);