diff options
| author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
| commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
| tree | 2fea02768d6005934547f075586c60ba7aca6253 /cmd/cros_ec.c | |
| parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (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 'cmd/cros_ec.c')
| -rw-r--r-- | cmd/cros_ec.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/cmd/cros_ec.c b/cmd/cros_ec.c index a40f5898b52..ad49905d67b 100644 --- a/cmd/cros_ec.c +++ b/cmd/cros_ec.c @@ -23,7 +23,7 @@ static const char * const ec_current_image_name[] = {"unknown", "RO", "RW"}; * * @param argc Number of params remaining * @param argv List of remaining parameters - * @return flash region (EC_FLASH_REGION_...) or -1 on error + * Return: flash region (EC_FLASH_REGION_...) or -1 on error */ static int cros_ec_decode_region(int argc, char *const argv[]) { @@ -48,7 +48,7 @@ static int cros_ec_decode_region(int argc, char *const argv[]) * @param is_write 1 do to a write, 0 to do a read * @param argc Number of arguments * @param argv Arguments (2 is region, 3 is address) - * @return 0 for ok, 1 for a usage error or -ve for ec command error + * Return: 0 for ok, 1 for a usage error or -ve for ec command error * (negative EC_RES_...) */ static int do_read_write(struct udevice *dev, int is_write, int argc, |