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 /env | |
| 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 'env')
| -rw-r--r-- | env/common.c | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/env/common.c b/env/common.c index ee957c0a8c..f9226e0690 100644 --- a/env/common.c +++ b/env/common.c @@ -47,7 +47,7 @@ struct hsearch_data env_htab = { * * @param varname Environment variable to set * @param value Value to set it to - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ int env_set_ulong(const char *varname, ulong value) { @@ -62,7 +62,7 @@ int env_set_ulong(const char *varname, ulong value) * * @param varname Environment variable to set * @param value Value to set it to - * @return 0 if ok, 1 on error + * Return: 0 if ok, 1 on error */ int env_set_hex(const char *varname, ulong value) { @@ -208,7 +208,7 @@ int env_get_f(const char *name, char *buf, unsigned len) * @param base Number base to use (normally 10, or 16 for hex) * @param default_val Default value to return if the variable is not * found - * @return the decoded value, or default_val if not found + * Return: the decoded value, or default_val if not found */ ulong env_get_ulong(const char *name, int base, ulong default_val) { |