summaryrefslogtreecommitdiff
path: root/scripts/dtc/util.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:05:50 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:11:34 +0300
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /scripts/dtc/util.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz
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 'scripts/dtc/util.h')
-rw-r--r--scripts/dtc/util.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/scripts/dtc/util.h b/scripts/dtc/util.h
index 66fba8ea70..211d584435 100644
--- a/scripts/dtc/util.h
+++ b/scripts/dtc/util.h
@@ -81,7 +81,7 @@ extern char *join_path(const char *path, const char *name);
*
* @param data The string to check
* @param len The string length including terminator
- * @return 1 if a valid printable string, 0 if not
+ * Return: 1 if a valid printable string, 0 if not
*/
bool util_is_printable_string(const void *data, int len);
@@ -98,7 +98,7 @@ char get_escape_char(const char *s, int *i);
* stderr.
*
* @param filename The filename to read, or - for stdin
- * @return Pointer to allocated buffer containing fdt, or NULL on error
+ * Return: Pointer to allocated buffer containing fdt, or NULL on error
*/
char *utilfdt_read(const char *filename);
@@ -116,7 +116,7 @@ char *utilfdt_read_len(const char *filename, off_t *len);
*
* @param filename The filename to read, or - for stdin
* @param buffp Returns pointer to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
*/
int utilfdt_read_err(const char *filename, char **buffp);
@@ -133,7 +133,7 @@ int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len);
*
* @param filename The filename to write, or - for stdout
* @param blob Poiner to buffer containing fdt
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
*/
int utilfdt_write(const char *filename, const void *blob);
@@ -144,7 +144,7 @@ int utilfdt_write(const char *filename, const void *blob);
*
* @param filename The filename to write, or - for stdout
* @param blob Poiner to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
*/
int utilfdt_write_err(const char *filename, const void *blob);
@@ -169,7 +169,7 @@ int utilfdt_write_err(const char *filename, const void *blob);
* @param fmt Format string to process
* @param type Returns type found(s/d/u/x), or 0 if none
* @param size Returns size found(1,2,4,8) or 4 if none
- * @return 0 if ok, -1 on error (no type given, or other invalid format)
+ * Return: 0 if ok, -1 on error (no type given, or other invalid format)
*/
int utilfdt_decode_type(const char *fmt, int *type, int *size);