aboutsummaryrefslogtreecommitdiff
path: root/tools/imagetool.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /tools/imagetool.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
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>
Diffstat (limited to 'tools/imagetool.h')
-rw-r--r--tools/imagetool.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/tools/imagetool.h b/tools/imagetool.h
index e229a34ffc5..3546f7a6711 100644
--- a/tools/imagetool.h
+++ b/tools/imagetool.h
@@ -176,7 +176,7 @@ struct image_type_params *imagetool_get_type(int type);
* supported image type. If verification is successful, this prints
* the respective header.
*
- * @return 0 on success, negative if input image format does not match with
+ * Return: 0 on success, negative if input image format does not match with
* any of supported image types
*/
int imagetool_verify_print_header(
@@ -195,7 +195,7 @@ int imagetool_verify_print_header(
* @tparams: image type parameters
* @params: mkimage parameters
*
- * @return 0 on success, negative if input image format does not match with
+ * Return: 0 on success, negative if input image format does not match with
* the given image type
*/
int imagetool_verify_print_header_by_type(
@@ -229,7 +229,7 @@ int imagetool_save_subimage(
*
* @params: mkimage parameters
* @fname: filename to check
- * @return size of file, or -ve value on error
+ * Return: size of file, or -ve value on error
*/
int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
@@ -243,7 +243,7 @@ int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
*
* @cmdname: command name
* @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
- * @return timestamp based on SOURCE_DATE_EPOCH
+ * Return: timestamp based on SOURCE_DATE_EPOCH
*/
time_t imagetool_get_source_date(
const char *cmdname,